executable-stories-formatters 1.13.0 → 1.15.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[];
@@ -2776,6 +2801,8 @@ interface CheckArgs {
     testCases: TestCaseResult[];
     /** Baseline scenario statuses keyed by scenario id, for regressed/fixed deltas. */
     baseline?: Map<string, TestStatus>;
+    /** Per-scenario time budget. Scenarios above it are named (see {@link CheckSlow}). */
+    maxDurationMs?: number;
     format: "text" | "json";
 }
 type CheckDeps = Record<string, never>;
@@ -2814,6 +2841,17 @@ interface CheckTurnedOff {
     status: "skipped" | "pending";
     tickets: string[];
 }
+/**
+ * A scenario that took longer than the budget. A slow suite is usually two or
+ * three scenarios, and nobody knows which until something names them.
+ */
+interface CheckSlow {
+    id: string;
+    scenario: string;
+    /** `sourceFile:sourceLine` */
+    location: string;
+    durationMs: number;
+}
 interface CheckReport {
     summary: {
         total: number;
@@ -2825,6 +2863,10 @@ interface CheckReport {
     failures: CheckFailure[];
     /** Scenarios switched off — named, not just counted (see {@link CheckTurnedOff}). */
     turnedOff: CheckTurnedOff[];
+    /** Scenarios over `--max-duration`, longest first. Empty without a budget. */
+    overBudget: CheckSlow[];
+    /** The budget those scenarios broke, for the message that names it. */
+    maxDurationMs?: number;
     /** Count of scenarios that went passed → failed vs. the baseline. */
     regressed: number;
     /** Count of scenarios that went failed → passed vs. the baseline. */
@@ -2900,6 +2942,22 @@ type GoalDeps = Record<string, never>;
 declare function buildGoal(args: GoalArgs, _deps?: GoalDeps): GoalReport;
 declare function renderGoal(report: GoalReport, format: "text" | "json"): string;
 
+/**
+ * CODEOWNERS parsing, so a failing scenario can name the team that fixes it.
+ *
+ * A red run that belongs to everyone belongs to nobody until someone
+ * volunteers. `triage --by-owner` groups the worklist the way the repo already
+ * divides responsibility, using the file every GitHub repo already has.
+ *
+ * Supports the common CODEOWNERS subset — leading `/`, trailing `/`,
+ * `*`, `**`, and bare extension globs. Character classes, `?`, and negation are
+ * not implemented; swap in a gitignore-grade matcher if a repo needs them.
+ */
+interface CodeownersRule {
+    pattern: string;
+    owners: string[];
+}
+
 /**
  * `triage` — the discovery-phase worklist for an agent loop.
  *
@@ -2920,6 +2978,8 @@ interface TriageItem {
     /** Product-code paths to fix. Empty when the scenario declared no `covers`. */
     covers: string[];
     tickets: string[];
+    /** CODEOWNERS entries for the code this scenario covers. Empty = unclaimed. */
+    owners: string[];
     errorMessage?: string;
     /** Passed in the baseline, failing now. Ranked first. */
     regressed: boolean;
@@ -2938,10 +2998,16 @@ interface TriageArgs {
     /** Baseline statuses by scenario id, to flag regressions and rank them first. */
     baseline?: Map<string, TestStatus>;
     format: "text" | "json";
+    /** Parsed CODEOWNERS. Without it every item is unowned. */
+    codeowners?: readonly CodeownersRule[];
 }
 type TriageDeps = Record<string, never>;
 declare function buildTriage(args: TriageArgs, _deps?: TriageDeps): TriageReport;
-declare function renderTriage(report: TriageReport, format: "text" | "json"): string;
+interface RenderTriageOptions {
+    /** Group the text worklist under each CODEOWNERS owner. */
+    byOwner?: boolean;
+}
+declare function renderTriage(report: TriageReport, format: "text" | "json", options?: RenderTriageOptions): string;
 
 /**
  * ReportGenerator — turns a canonical TestRunResult into report files.

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[];
@@ -2776,6 +2801,8 @@ interface CheckArgs {
     testCases: TestCaseResult[];
     /** Baseline scenario statuses keyed by scenario id, for regressed/fixed deltas. */
     baseline?: Map<string, TestStatus>;
+    /** Per-scenario time budget. Scenarios above it are named (see {@link CheckSlow}). */
+    maxDurationMs?: number;
     format: "text" | "json";
 }
 type CheckDeps = Record<string, never>;
@@ -2814,6 +2841,17 @@ interface CheckTurnedOff {
     status: "skipped" | "pending";
     tickets: string[];
 }
+/**
+ * A scenario that took longer than the budget. A slow suite is usually two or
+ * three scenarios, and nobody knows which until something names them.
+ */
+interface CheckSlow {
+    id: string;
+    scenario: string;
+    /** `sourceFile:sourceLine` */
+    location: string;
+    durationMs: number;
+}
 interface CheckReport {
     summary: {
         total: number;
@@ -2825,6 +2863,10 @@ interface CheckReport {
     failures: CheckFailure[];
     /** Scenarios switched off — named, not just counted (see {@link CheckTurnedOff}). */
     turnedOff: CheckTurnedOff[];
+    /** Scenarios over `--max-duration`, longest first. Empty without a budget. */
+    overBudget: CheckSlow[];
+    /** The budget those scenarios broke, for the message that names it. */
+    maxDurationMs?: number;
     /** Count of scenarios that went passed → failed vs. the baseline. */
     regressed: number;
     /** Count of scenarios that went failed → passed vs. the baseline. */
@@ -2900,6 +2942,22 @@ type GoalDeps = Record<string, never>;
 declare function buildGoal(args: GoalArgs, _deps?: GoalDeps): GoalReport;
 declare function renderGoal(report: GoalReport, format: "text" | "json"): string;
 
+/**
+ * CODEOWNERS parsing, so a failing scenario can name the team that fixes it.
+ *
+ * A red run that belongs to everyone belongs to nobody until someone
+ * volunteers. `triage --by-owner` groups the worklist the way the repo already
+ * divides responsibility, using the file every GitHub repo already has.
+ *
+ * Supports the common CODEOWNERS subset — leading `/`, trailing `/`,
+ * `*`, `**`, and bare extension globs. Character classes, `?`, and negation are
+ * not implemented; swap in a gitignore-grade matcher if a repo needs them.
+ */
+interface CodeownersRule {
+    pattern: string;
+    owners: string[];
+}
+
 /**
  * `triage` — the discovery-phase worklist for an agent loop.
  *
@@ -2920,6 +2978,8 @@ interface TriageItem {
     /** Product-code paths to fix. Empty when the scenario declared no `covers`. */
     covers: string[];
     tickets: string[];
+    /** CODEOWNERS entries for the code this scenario covers. Empty = unclaimed. */
+    owners: string[];
     errorMessage?: string;
     /** Passed in the baseline, failing now. Ranked first. */
     regressed: boolean;
@@ -2938,10 +2998,16 @@ interface TriageArgs {
     /** Baseline statuses by scenario id, to flag regressions and rank them first. */
     baseline?: Map<string, TestStatus>;
     format: "text" | "json";
+    /** Parsed CODEOWNERS. Without it every item is unowned. */
+    codeowners?: readonly CodeownersRule[];
 }
 type TriageDeps = Record<string, never>;
 declare function buildTriage(args: TriageArgs, _deps?: TriageDeps): TriageReport;
-declare function renderTriage(report: TriageReport, format: "text" | "json"): string;
+interface RenderTriageOptions {
+    /** Group the text worklist under each CODEOWNERS owner. */
+    byOwner?: boolean;
+}
+declare function renderTriage(report: TriageReport, format: "text" | "json", options?: RenderTriageOptions): string;
 
 /**
  * ReportGenerator — turns a canonical TestRunResult into report files.