executable-stories-react 0.6.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -75,7 +75,7 @@ interface ReportCoverageSummary {
75
75
  functionsPct?: number;
76
76
  statementsPct?: number;
77
77
  }
78
- type ReportDocEntry = ReportDocNote | ReportDocTag | ReportDocKv | ReportDocCode | ReportDocTable | ReportDocLink | ReportDocSection | ReportDocMermaid | ReportDocScreenshot | ReportDocVideo | ReportDocHtml | ReportDocCustom;
78
+ type ReportDocEntry = ReportDocNote | ReportDocTag | ReportDocKv | ReportDocCode | ReportDocTable | ReportDocLink | ReportDocSection | ReportDocMermaid | ReportDocScreenshot | ReportDocVideo | ReportDocHtml | ReportDocState | ReportDocCustom;
79
79
  interface ReportDocNote {
80
80
  kind: "note";
81
81
  text: string;
@@ -161,6 +161,15 @@ interface ReportDocHtml {
161
161
  phase: DocPhase;
162
162
  children?: ReportDocEntry[];
163
163
  }
164
+ interface ReportDocState {
165
+ kind: "state";
166
+ /** Entity name ("Basket") — diff identity across steps. Unlabeled states share one lane. */
167
+ label?: string;
168
+ /** JSON-serializable snapshot of the state at this step. */
169
+ value: unknown;
170
+ phase: DocPhase;
171
+ children?: ReportDocEntry[];
172
+ }
164
173
  interface ReportDocCustom {
165
174
  kind: "custom";
166
175
  type: string;
@@ -369,6 +378,25 @@ declare function ReportStepItem({ step }: {
369
378
  step: ReportStep;
370
379
  }): react.JSX.Element;
371
380
 
381
+ interface ReportStoryboardProps {
382
+ scenario: ReportScenario$1;
383
+ }
384
+ /**
385
+ * Storyboard — a horizontal filmstrip of the scenario's step evidence
386
+ * (Given → When → Then), derived from the same step docs the vertical step
387
+ * list renders. A frame is a container: the step's screenshot (when present)
388
+ * plus its `story.state()` snapshot cards, so data-only scenarios get
389
+ * filmstrips too. Each frame links to its step's anchor.
390
+ *
391
+ * Renders nothing below 2 frames: a single capture is evidence, not a
392
+ * walkthrough, and it already shows under its step.
393
+ *
394
+ * Must stay hydration-free: the Astro story pages render this inside a static
395
+ * (no client JS) island, so navigation is plain anchors and snapshot expansion
396
+ * is a native <details> — no lightbox or toggle state.
397
+ */
398
+ declare function ReportStoryboard({ scenario }: ReportStoryboardProps): react.JSX.Element | null;
399
+
372
400
  interface ReportDocEntriesProps {
373
401
  entries: readonly ReportDocEntry[];
374
402
  }
@@ -619,4 +647,4 @@ declare const STORY_REPORT_SCHEMA_MAJOR: 1;
619
647
 
620
648
  declare const storyReportSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
621
649
 
622
- export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, MermaidDiagram, MermaidSource, Report, ReportAttachments, ReportDocEntries, type ReportDocEntriesProps, ReportEmpty, type ReportEmptyProps, ReportFeature, ReportFeatureList, type ReportFeatureProps, ReportMeta, type ReportParseError, type ReportParseErrorCode, type ReportProps, ReportRoot, type ReportRootProps, ReportScenario, ReportScenarioList, type ReportScenarioListProps, type ReportScenarioProps, ReportSchemaError, type ReportSchemaErrorProps, ReportStepItem, ReportSteps, type ReportStepsProps, ReportSummary, type ReportSummaryProps, ReportSummaryView, type ReportSummaryViewProps, ReportTrace, type Result, type RunStreak, STORY_REPORT_SCHEMA_MAJOR, ScenarioExplorer, type ScenarioExplorerProps, type ScenarioHistoryMap, type ScenarioRunEvent, ScenarioRunHistory, type ScenarioRunStatus, type StoryReport, type ReportDocEntry as StoryReportDocEntry, type ReportFeature$1 as StoryReportFeature, type ReportScenario$1 as StoryReportScenario, type ReportStep as StoryReportStep, type ReportSummary$1 as StoryReportSummary, ciDisplayName, commitUrl, currentStreak, describeRunHistory, err, formatRelativeAge, isReportStale, ok, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };
650
+ export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, MermaidDiagram, MermaidSource, Report, ReportAttachments, ReportDocEntries, type ReportDocEntriesProps, ReportEmpty, type ReportEmptyProps, ReportFeature, ReportFeatureList, type ReportFeatureProps, ReportMeta, type ReportParseError, type ReportParseErrorCode, type ReportProps, ReportRoot, type ReportRootProps, ReportScenario, ReportScenarioList, type ReportScenarioListProps, type ReportScenarioProps, ReportSchemaError, type ReportSchemaErrorProps, ReportStepItem, ReportSteps, type ReportStepsProps, ReportStoryboard, type ReportStoryboardProps, ReportSummary, type ReportSummaryProps, ReportSummaryView, type ReportSummaryViewProps, ReportTrace, type Result, type RunStreak, STORY_REPORT_SCHEMA_MAJOR, ScenarioExplorer, type ScenarioExplorerProps, type ScenarioHistoryMap, type ScenarioRunEvent, ScenarioRunHistory, type ScenarioRunStatus, type StoryReport, type ReportDocEntry as StoryReportDocEntry, type ReportFeature$1 as StoryReportFeature, type ReportScenario$1 as StoryReportScenario, type ReportStep as StoryReportStep, type ReportSummary$1 as StoryReportSummary, ciDisplayName, commitUrl, currentStreak, describeRunHistory, err, formatRelativeAge, isReportStale, ok, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };
package/dist/index.d.ts CHANGED
@@ -75,7 +75,7 @@ interface ReportCoverageSummary {
75
75
  functionsPct?: number;
76
76
  statementsPct?: number;
77
77
  }
78
- type ReportDocEntry = ReportDocNote | ReportDocTag | ReportDocKv | ReportDocCode | ReportDocTable | ReportDocLink | ReportDocSection | ReportDocMermaid | ReportDocScreenshot | ReportDocVideo | ReportDocHtml | ReportDocCustom;
78
+ type ReportDocEntry = ReportDocNote | ReportDocTag | ReportDocKv | ReportDocCode | ReportDocTable | ReportDocLink | ReportDocSection | ReportDocMermaid | ReportDocScreenshot | ReportDocVideo | ReportDocHtml | ReportDocState | ReportDocCustom;
79
79
  interface ReportDocNote {
80
80
  kind: "note";
81
81
  text: string;
@@ -161,6 +161,15 @@ interface ReportDocHtml {
161
161
  phase: DocPhase;
162
162
  children?: ReportDocEntry[];
163
163
  }
164
+ interface ReportDocState {
165
+ kind: "state";
166
+ /** Entity name ("Basket") — diff identity across steps. Unlabeled states share one lane. */
167
+ label?: string;
168
+ /** JSON-serializable snapshot of the state at this step. */
169
+ value: unknown;
170
+ phase: DocPhase;
171
+ children?: ReportDocEntry[];
172
+ }
164
173
  interface ReportDocCustom {
165
174
  kind: "custom";
166
175
  type: string;
@@ -369,6 +378,25 @@ declare function ReportStepItem({ step }: {
369
378
  step: ReportStep;
370
379
  }): react.JSX.Element;
371
380
 
381
+ interface ReportStoryboardProps {
382
+ scenario: ReportScenario$1;
383
+ }
384
+ /**
385
+ * Storyboard — a horizontal filmstrip of the scenario's step evidence
386
+ * (Given → When → Then), derived from the same step docs the vertical step
387
+ * list renders. A frame is a container: the step's screenshot (when present)
388
+ * plus its `story.state()` snapshot cards, so data-only scenarios get
389
+ * filmstrips too. Each frame links to its step's anchor.
390
+ *
391
+ * Renders nothing below 2 frames: a single capture is evidence, not a
392
+ * walkthrough, and it already shows under its step.
393
+ *
394
+ * Must stay hydration-free: the Astro story pages render this inside a static
395
+ * (no client JS) island, so navigation is plain anchors and snapshot expansion
396
+ * is a native <details> — no lightbox or toggle state.
397
+ */
398
+ declare function ReportStoryboard({ scenario }: ReportStoryboardProps): react.JSX.Element | null;
399
+
372
400
  interface ReportDocEntriesProps {
373
401
  entries: readonly ReportDocEntry[];
374
402
  }
@@ -619,4 +647,4 @@ declare const STORY_REPORT_SCHEMA_MAJOR: 1;
619
647
 
620
648
  declare const storyReportSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
621
649
 
622
- export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, MermaidDiagram, MermaidSource, Report, ReportAttachments, ReportDocEntries, type ReportDocEntriesProps, ReportEmpty, type ReportEmptyProps, ReportFeature, ReportFeatureList, type ReportFeatureProps, ReportMeta, type ReportParseError, type ReportParseErrorCode, type ReportProps, ReportRoot, type ReportRootProps, ReportScenario, ReportScenarioList, type ReportScenarioListProps, type ReportScenarioProps, ReportSchemaError, type ReportSchemaErrorProps, ReportStepItem, ReportSteps, type ReportStepsProps, ReportSummary, type ReportSummaryProps, ReportSummaryView, type ReportSummaryViewProps, ReportTrace, type Result, type RunStreak, STORY_REPORT_SCHEMA_MAJOR, ScenarioExplorer, type ScenarioExplorerProps, type ScenarioHistoryMap, type ScenarioRunEvent, ScenarioRunHistory, type ScenarioRunStatus, type StoryReport, type ReportDocEntry as StoryReportDocEntry, type ReportFeature$1 as StoryReportFeature, type ReportScenario$1 as StoryReportScenario, type ReportStep as StoryReportStep, type ReportSummary$1 as StoryReportSummary, ciDisplayName, commitUrl, currentStreak, describeRunHistory, err, formatRelativeAge, isReportStale, ok, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };
650
+ export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, MermaidDiagram, MermaidSource, Report, ReportAttachments, ReportDocEntries, type ReportDocEntriesProps, ReportEmpty, type ReportEmptyProps, ReportFeature, ReportFeatureList, type ReportFeatureProps, ReportMeta, type ReportParseError, type ReportParseErrorCode, type ReportProps, ReportRoot, type ReportRootProps, ReportScenario, ReportScenarioList, type ReportScenarioListProps, type ReportScenarioProps, ReportSchemaError, type ReportSchemaErrorProps, ReportStepItem, ReportSteps, type ReportStepsProps, ReportStoryboard, type ReportStoryboardProps, ReportSummary, type ReportSummaryProps, ReportSummaryView, type ReportSummaryViewProps, ReportTrace, type Result, type RunStreak, STORY_REPORT_SCHEMA_MAJOR, ScenarioExplorer, type ScenarioExplorerProps, type ScenarioHistoryMap, type ScenarioRunEvent, ScenarioRunHistory, type ScenarioRunStatus, type StoryReport, type ReportDocEntry as StoryReportDocEntry, type ReportFeature$1 as StoryReportFeature, type ReportScenario$1 as StoryReportScenario, type ReportStep as StoryReportStep, type ReportSummary$1 as StoryReportSummary, ciDisplayName, commitUrl, currentStreak, describeRunHistory, err, formatRelativeAge, isReportStale, ok, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };