executable-stories-react 0.8.0 → 0.10.0

package/dist/index.d.cts

@@ -513,6 +513,50 @@ declare function DocCustom({ entry }: {
     entry: ReportDocCustom;
 }): react.JSX.Element;
 
+declare const FILE_TREE_TYPE = "file-tree";
+declare const DATA_MODEL_TYPE = "data-model";
+/** Change annotation shared by both blocks. */
+type ChangeKind = "added" | "modified" | "removed" | "renamed";
+interface FileEntry {
+    path: string;
+    change?: ChangeKind;
+    note?: string;
+}
+interface FileTreeData {
+    title?: string;
+    authored?: string;
+    files: FileEntry[];
+}
+declare function parseFileTree(data: unknown): FileTreeData | undefined;
+declare function FileTreeBlock({ entry }: {
+    entry: ReportDocCustom;
+}): react.JSX.Element;
+interface ModelField {
+    name: string;
+    type?: string;
+    note?: string;
+    change?: ChangeKind;
+}
+interface DataModelData {
+    title?: string;
+    authored?: string;
+    name?: string;
+    fields: ModelField[];
+}
+declare function parseDataModel(data: unknown): DataModelData | undefined;
+declare function DataModelBlock({ entry }: {
+    entry: ReportDocCustom;
+}): react.JSX.Element;
+/**
+ * The narrative block renderers, ready to spread into `customRenderers`.
+ * Consumer-supplied renderers for the same type win, so a project can swap
+ * either one out.
+ */
+declare const narrativeBlockRenderers: {
+    "file-tree": (entry: ReportDocCustom) => react.JSX.Element;
+    "data-model": (entry: ReportDocCustom) => react.JSX.Element;
+};
+
 type ExplorerStatus = "passed" | "failed" | "skipped" | "pending";
 interface ExplorerScenario {
     id: string;
@@ -647,4 +691,4 @@ declare const STORY_REPORT_SCHEMA_MAJOR: 1;
 
 declare const storyReportSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 
-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 };
+export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DATA_MODEL_TYPE, DataModelBlock, type DataModelData, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, FILE_TREE_TYPE, FileTreeBlock, type FileTreeData, 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, narrativeBlockRenderers, ok, parseDataModel, parseFileTree, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };

package/dist/index.d.ts

@@ -513,6 +513,50 @@ declare function DocCustom({ entry }: {
     entry: ReportDocCustom;
 }): react.JSX.Element;
 
+declare const FILE_TREE_TYPE = "file-tree";
+declare const DATA_MODEL_TYPE = "data-model";
+/** Change annotation shared by both blocks. */
+type ChangeKind = "added" | "modified" | "removed" | "renamed";
+interface FileEntry {
+    path: string;
+    change?: ChangeKind;
+    note?: string;
+}
+interface FileTreeData {
+    title?: string;
+    authored?: string;
+    files: FileEntry[];
+}
+declare function parseFileTree(data: unknown): FileTreeData | undefined;
+declare function FileTreeBlock({ entry }: {
+    entry: ReportDocCustom;
+}): react.JSX.Element;
+interface ModelField {
+    name: string;
+    type?: string;
+    note?: string;
+    change?: ChangeKind;
+}
+interface DataModelData {
+    title?: string;
+    authored?: string;
+    name?: string;
+    fields: ModelField[];
+}
+declare function parseDataModel(data: unknown): DataModelData | undefined;
+declare function DataModelBlock({ entry }: {
+    entry: ReportDocCustom;
+}): react.JSX.Element;
+/**
+ * The narrative block renderers, ready to spread into `customRenderers`.
+ * Consumer-supplied renderers for the same type win, so a project can swap
+ * either one out.
+ */
+declare const narrativeBlockRenderers: {
+    "file-tree": (entry: ReportDocCustom) => react.JSX.Element;
+    "data-model": (entry: ReportDocCustom) => react.JSX.Element;
+};
+
 type ExplorerStatus = "passed" | "failed" | "skipped" | "pending";
 interface ExplorerScenario {
     id: string;
@@ -647,4 +691,4 @@ declare const STORY_REPORT_SCHEMA_MAJOR: 1;
 
 declare const storyReportSchema: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 
-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 };
+export { type BuiltinRenderers, type CustomRenderer, type CustomRenderers, DATA_MODEL_TYPE, DataModelBlock, type DataModelData, DocCode, DocCustom, DocEntry, DocHtml, DocKv, DocLink, DocMermaid, DocNote, DocScreenshot, DocSection, DocTable, DocTag, DocVideo, type ExplorerScenario, type ExplorerStatus, FILE_TREE_TYPE, FileTreeBlock, type FileTreeData, 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, narrativeBlockRenderers, ok, parseDataModel, parseFileTree, parseStoryReport, prUrl, reportLastRunMs, storyReportSchema, useBuiltinRenderers, useCustomRenderers, useReport };