Add ReportingAPI interface and reporting property to StoryContext

ComponentDriven · Nov 14, 2024 · bb5bb77 · bb5bb77
1 parent 18dbdbe
commit bb5bb77
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/story.ts b/src/story.ts
@@ -63,6 +63,18 @@ interface ControlBase {
   disable?: boolean;
 }
 
+interface Report {
+  id: string;
+  version: number;
+  result: unknown;
+  status: 'failed' | 'passed' | 'warning';
+}
+
+interface ReportingAPI {
+  reports: Report[];
+  addReport: (report: Report) => void;
+}
+
 type Control =
   | ControlType
   | false
@@ -278,6 +290,7 @@ export interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Arg
   context: this;
   canvas: Canvas;
   mount: TRenderer['mount'];
+  reporting: ReportingAPI;
 }
 
 /** @deprecated Use {@link StoryContext} instead. */