executable-stories-formatters 1.13.0 → 1.14.0

package/dist/index.d.cts

@@ -1655,6 +1655,20 @@ interface ScenarioIndex {
     summary: StoryReport["summary"];
     scenarios: ScenarioIndexItem[];
 }
+/**
+ * One scenario as this formatter emits it.
+ *
+ * This is an OUTPUT type: it describes what `toScenarioIndex` produces, which
+ * is why `hash` and `assertionState` are required here while
+ * `scenario-index-v1.json` marks both optional. The schema is deliberately the
+ * laxer of the two so artifacts written before either field existed still
+ * validate; every artifact written since carries them.
+ *
+ * The consequence, and it is intended: parsing an arbitrary v1 file and casting
+ * it to this type is not sound for those two fields. Validate against the
+ * schema and treat them as optional if you are reading files you did not just
+ * write.
+ */
 interface ScenarioIndexItem {
     id: string;
     title: string;
@@ -1681,6 +1695,12 @@ interface ScenarioIndexItem {
         message: string;
         stack?: string;
     };
+    /**
+     * Whether the scenario's claim was checked: `asserted`, `unasserted`, or
+     * `unobserved` where the adapter cannot count. A passing scenario that is
+     * `unasserted` ran and proved nothing.
+     */
+    assertionState: "asserted" | "unasserted" | "unobserved";
 }
 interface ScenarioIndexStep {
     id: string;
@@ -1691,6 +1711,11 @@ interface ScenarioIndexStep {
     durationMs: number;
     errorMessage?: string;
     docKinds: string[];
+    /**
+     * Assertions the framework observed. Absent means the adapter has no counter;
+     * `0` means it counted none. Never defaulted — the difference is the point.
+     */
+    assertions?: number;
 }
 interface ScenarioIndexFilters {
     statuses?: TestStatus$1[];

package/dist/index.d.ts

@@ -1655,6 +1655,20 @@ interface ScenarioIndex {
     summary: StoryReport["summary"];
     scenarios: ScenarioIndexItem[];
 }
+/**
+ * One scenario as this formatter emits it.
+ *
+ * This is an OUTPUT type: it describes what `toScenarioIndex` produces, which
+ * is why `hash` and `assertionState` are required here while
+ * `scenario-index-v1.json` marks both optional. The schema is deliberately the
+ * laxer of the two so artifacts written before either field existed still
+ * validate; every artifact written since carries them.
+ *
+ * The consequence, and it is intended: parsing an arbitrary v1 file and casting
+ * it to this type is not sound for those two fields. Validate against the
+ * schema and treat them as optional if you are reading files you did not just
+ * write.
+ */
 interface ScenarioIndexItem {
     id: string;
     title: string;
@@ -1681,6 +1695,12 @@ interface ScenarioIndexItem {
         message: string;
         stack?: string;
     };
+    /**
+     * Whether the scenario's claim was checked: `asserted`, `unasserted`, or
+     * `unobserved` where the adapter cannot count. A passing scenario that is
+     * `unasserted` ran and proved nothing.
+     */
+    assertionState: "asserted" | "unasserted" | "unobserved";
 }
 interface ScenarioIndexStep {
     id: string;
@@ -1691,6 +1711,11 @@ interface ScenarioIndexStep {
     durationMs: number;
     errorMessage?: string;
     docKinds: string[];
+    /**
+     * Assertions the framework observed. Absent means the adapter has no counter;
+     * `0` means it counted none. Never defaulted — the difference is the point.
+     */
+    assertions?: number;
 }
 interface ScenarioIndexFilters {
     statuses?: TestStatus$1[];