niceeval 0.6.1 → 0.7.0

package/dist/report/components.d.ts

@@ -1,180 +1,113 @@
-import type { ReportComponent } from "./tree.ts";
+import { type ReportComponent } from "./tree.ts";
 import type { ReportLocale } from "./locale.ts";
 import type { AttemptLocator } from "../results/locator.ts";
-import type { Selection } from "../results/types.ts";
-import type { AttemptListItem, DeltaData, EvalListItem, ExperimentListItem, GroupSummaryData, LineData, MatrixData, OverviewData, ScatterData, ScoreboardData, TableData } from "./types.ts";
-import { attemptListData, deltaData, evalListData, experimentListData, groupSummaryData, lineData, matrixData, overviewData, scatterData, scoreboardData, tableData } from "./compute.ts";
-import type { ScatterDataOptions } from "./compute.ts";
-export interface RunOverviewProps {
-    data: OverviewData;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-export interface GroupSummaryProps {
-    data: GroupSummaryData;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
+import type { AttemptListItem, DeltaData, EntityListDataOptions, EvalListItem, ExperimentComparisonData, ExperimentListItem, LineData, MatrixData, ReportInput, ScatterData, ScopeSummaryData, ScoreboardData, TableData } from "./types.ts";
+import { type DeltaTableOptions, type MetricLineOptions, type MetricMatrixOptions, type MetricScatterOptions, type MetricTableOptions, type ScoreboardOptions } from "./compute.ts";
+type Never<T> = {
+    [K in keyof T]?: never;
+};
 /**
- * 三个实体列表都只收算好的 `items`(`.data(selection)` 的产物,报告作者先 `.filter()`/
- * `.slice()` 再传入)——没有 selection-form,组件不提供另一套过滤 DSL
- * (docs/feature/reports/library.md「实体列表」)。
+ * 官方数据组件的统一 props 组合(docs/feature/reports/library/metric-views.md):
+ * data 形态(接收配套 *Data 的产物)或 spec 形态(Options 平铺 + 可选 input)。
  */
-export interface ExperimentListProps {
-    items: ExperimentListItem[];
-    /** web 面在比较表前显示实验过滤框；text 面忽略。 */
-    filter?: boolean;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-export interface EvalListProps {
-    items: EvalListItem[];
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-export interface AttemptListProps {
-    items: AttemptListItem[];
-    /** items 被 slice 时如实显示剩余数量;省略即 items.length(未截断)。 */
-    total?: number;
+export type DataProps<Data, Options, Presentation> = ({
+    data: Data;
+    input?: never;
+} & Never<Options> & Presentation) | ({
+    data?: never;
+    input?: ReportInput;
+} & Options & Presentation);
+interface ChromeProps {
     /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
     locale?: ReportLocale;
     className?: string;
 }
-export interface MetricTableProps {
-    data: TableData;
-    /** 传了,格子可点、下钻去处你定;不传,宿主里走证据室深链,宿主外纯展示。 */
+export type ScopeSummaryProps = DataProps<ScopeSummaryData, Record<never, never>, ChromeProps & {
+    /** 显示哪一级计票;默认 "eval"。data 恒携带两级,votes 只选择呈现。 */
+    votes?: "eval" | "attempt";
+}>;
+/** 范围摘要卡:时间窗、数量、两级计票、端到端成功率与总成本。 */
+export declare const ScopeSummary: ReportComponent<ScopeSummaryProps>;
+export type ExperimentComparisonProps = DataProps<ExperimentComparisonData, Record<never, never>, ChromeProps>;
+/**
+ * 内建报告的默认组合件:先把 input 按可比组分区,再为每组分别计算 ScopeSummary、
+ * 成本 × 端到端成功率散点和 ExperimentList。web 面持有完整组索引并一次聚焦一组;
+ * text 面命中多个组时只显示组索引与可执行的单组查看命令,命中单组时才输出完整散点与列表。
+ */
+export declare const ExperimentComparison: ReportComponent<ExperimentComparisonProps>;
+interface EntityListChrome extends ChromeProps {
     attemptHref?: (locator: AttemptLocator) => string;
+}
+export type ExperimentListProps = DataProps<readonly ExperimentListItem[], EntityListDataOptions, EntityListChrome & {
+    /** web 面在比较表前显示实验过滤框;text 面忽略。 */
+    filter?: boolean;
     /**
-     * web 面在表格前渲染一个过滤输入框(`<input class="nre-filter" data-nre-filter>`),
-     * 由渐进增强 runtime(enhance.js)接管:输入过滤行 textContent。无 JS 时输入框
-     * 静默无功能,表格内容依旧完整可读。默认 false;text 面不受影响。
+     * 可选父路径:两面的行标签去掉与它相同的前缀,只显示 experiment id 末段(默认
+     * `ExperimentComparison` 给每组传组键)。完整 id 仍是排序 / 着色 / 过滤 / 折叠的键。
      */
-    filter?: boolean;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-export interface MetricMatrixProps {
-    data: MatrixData;
+    relativeTo?: string;
+}>;
+/** 实验列表:每项一个 experiment,固定八列比较表 + 展开到 Eval / Attempt。 */
+export declare const ExperimentList: ReportComponent<ExperimentListProps>;
+export type EvalListProps = DataProps<readonly EvalListItem[], EntityListDataOptions, EntityListChrome>;
+/** Eval 列表:每项一个 experimentId + evalId,展开到这道题的 Attempt。 */
+export declare const EvalList: ReportComponent<EvalListProps>;
+export type AttemptListProps = DataProps<readonly AttemptListItem[], EntityListDataOptions, EntityListChrome & {
+    /** 过滤 / 截断前的总数;省略时等于 data 长度。 */
+    total?: number;
+}>;
+/** Attempt 列表:实体列表的叶子层,每项一次 attempt 的判定、单行摘要与 locator。 */
+export declare const AttemptList: ReportComponent<AttemptListProps>;
+export interface FailureListProps {
+    /** 显示的最大条数;默认 20。 */
+    limit?: number;
+    /** 默认宿主注入的 Scope。 */
+    input?: ReportInput;
+    redact?: (text: string) => string;
     attemptHref?: (locator: AttemptLocator) => string;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-export interface ScoreboardProps {
-    data: ScoreboardData;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-/** MetricScatter 两臂共享的纯渲染选项(不含数据来源)。 */
-interface MetricScatterRenderProps {
-    /** 点一个点 → 该配置的下钻页。 */
-    pointHref?: (row: ScatterData["rows"][number]) => string;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-/** resolve 之后 web / text 面看到的形态:数据已备好,零 IO。 */
-export interface MetricScatterResolvedProps extends MetricScatterRenderProps {
-    data: ScatterData;
-}
-/**
- * 互斥两臂:要么直接给算好的 `data`(用于用户自己的 React 页面 / 预计算 / 跨边界序列化),
- * 要么给 `selection` + 计算选项让宿主在渲染前解析(见 tree.ts 的 resolveReportTree)。
- * 同时传 `data` 与 `selection`、或两者都不传,都在 typecheck 阶段失败。计算选项复用
- * `ScatterDataOptions`,不手写会漂移的副本。
- */
-export type MetricScatterProps = (MetricScatterResolvedProps & {
-    selection?: never;
-    points?: never;
-    series?: never;
-    x?: never;
-    y?: never;
-}) | ({
-    data?: never;
-} & ScatterDataOptions & MetricScatterRenderProps & {
-    selection: Selection;
-});
-export interface MetricLineProps {
-    data: LineData;
-    pointHref?: (row: LineData["rows"][number]) => string;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
     locale?: ReportLocale;
     className?: string;
 }
-export interface DeltaTableProps {
-    data: DeltaData;
-    /** chrome 文案 locale;省略时随宿主上下文(宿主外默认 "en")。 */
-    locale?: ReportLocale;
-    className?: string;
-}
-/** 页头 KPI 条:何时跑的、几个配置、几道题、通过率、总成本;Selection 的警告随行显示在条内。 */
-export declare const RunOverview: ReportComponent<RunOverviewProps> & {
-    data: typeof overviewData;
-};
 /**
- * 组摘要:一组 experiment(典型用法是同一 `<Section>` 内的全部 experiment)的紧凑统计——
- * 通过率(旧 GroupSelector 卡片口径)、experiment/eval/attempt 数、eval 级折叠计票、
- * 总成本、最后运行时间。
+ * 「现在有哪些失败要处理」的成品组合件:内部就是 attemptListData → 过滤 → AttemptList
+ * data 形态,与手写组合严格等价、没有私有能力(docs/feature/reports/library/entity-lists.md)。
+ * verdict ∈ failed / errored,按 attempt 开始时间降序(同刻按 locator 字典序),
+ * 截断到 limit(默认 20),total 报告截断前总数。
  */
-export declare const GroupSummary: ReportComponent<GroupSummaryProps> & {
-    data: typeof groupSummaryData;
-};
-/**
- * 实验列表:每项一个 experiment,固定展示身份、配置(flags)、Eval 判定构成和官方两级聚合
- * 汇总指标;展开到这个 experiment 的 Eval,每道题内联该题全部 Attempt 的 locator 徽标。
- * 没有 selection-form:`ExperimentList.data(selection)` 产出普通数组,过滤由报告作者对
- * 数组调用 `.filter()`。
- */
-export declare const ExperimentList: ReportComponent<ExperimentListProps> & {
-    data: typeof experimentListData;
-};
-/**
- * Eval 列表:每项一个 `experimentId + evalId`,固定展示判定、Attempt 数、分数、成本、耗时
- * 与失败原因;展开到这道题的 Attempt(与 AttemptList 同一份 AttemptListItem)。
- */
-export declare const EvalList: ReportComponent<EvalListProps> & {
-    data: typeof evalListData;
-};
-/**
- * Attempt 列表:实体列表的叶子层,每项一个 Attempt,固定展示判定、断言、error、Judge 评语
- * (assertions 的 detail/evidence)与证据引用(locator)。它不预设只看失败;
- * 报告作者过滤 `AttemptListItem[]`、用 `.slice()` 限量,`total` 让渲染面如实报告剩余数量。
- */
-export declare const AttemptList: ReportComponent<AttemptListProps> & {
-    data: typeof attemptListData;
-};
+export declare const FailureList: ReportComponent<FailureListProps>;
+export type MetricTableProps = DataProps<TableData, MetricTableOptions, ChromeProps & {
+    /** web 面在表格前渲染过滤输入框(enhance.js 接管);无 JS 时表格内容依旧完整。 */
+    filter?: boolean;
+    attemptHref?: (locator: AttemptLocator) => string;
+}>;
 /** 榜单:一行一个维度值、一列一个指标,回答「谁整体更好」。 */
-export declare const MetricTable: ReportComponent<MetricTableProps> & {
-    data: typeof tableData;
-};
+export declare const MetricTable: ReportComponent<MetricTableProps>;
+export type MetricMatrixProps = DataProps<MatrixData, MetricMatrixOptions, ChromeProps & {
+    attemptHref?: (locator: AttemptLocator) => string;
+}>;
+export type MetricBarsProps = MetricMatrixProps;
 /** 逐题格子:行 × 列两个维度、格子里一个指标,回答「哪道题谁挂了」。 */
-export declare const MetricMatrix: ReportComponent<MetricMatrixProps> & {
-    data: typeof matrixData;
-};
-/** 分组条形:同一份矩阵数据的另一种摆法;MetricBars.data 就是 MetricMatrix.data 的别名。 */
-export declare const MetricBars: ReportComponent<MetricMatrixProps> & {
-    data: typeof matrixData;
-};
-/** 考试成绩单:总分 + 分科小计,固定分母、missing 如实报。 */
-export declare const Scoreboard: ReportComponent<ScoreboardProps> & {
-    data: typeof scoreboardData;
-};
-/** 质量 × 成本 frontier:每个点一个配置、两个指标各占一轴,「好」的角落恒在右上。 */
-export declare const MetricScatter: ReportComponent<MetricScatterProps> & {
-    data: typeof scatterData;
-};
-/** 趋势线:x 是 experiment 声明的 flag(flag()),同系列按 x 排序连线。 */
-export declare const MetricLine: ReportComponent<MetricLineProps> & {
-    data: typeof lineData;
-};
-/** 成对对比:每行一对配置、格子里 A、B、Δ 三个值,涨跌好坏由 better 判定。 */
-export declare const DeltaTable: ReportComponent<DeltaTableProps> & {
-    data: typeof deltaData;
-};
+export declare const MetricMatrix: ReportComponent<MetricMatrixProps>;
+/** 分组条形:同一份矩阵数据的另一种摆法;与 MetricMatrix 写同一份 spec 时只计算一次。 */
+export declare const MetricBars: ReportComponent<MetricBarsProps>;
+export type ScoreboardProps = DataProps<ScoreboardData, ScoreboardOptions, ChromeProps & {
+    attemptHref?: (locator: AttemptLocator) => string;
+}>;
+/** 考试成绩单:总分 + 分科小计,固定分母、notRun / unscorable 分开如实报。 */
+export declare const Scoreboard: ReportComponent<ScoreboardProps>;
+export type MetricScatterProps = DataProps<ScatterData, MetricScatterOptions, ChromeProps & {
+    pointHref?: (row: ScatterData["rows"][number]) => string;
+}>;
+/** 两个指标之间的取舍:每个点一个维度值,x / y 各一个指标,series 只决定颜色和分组。 */
+export declare const MetricScatter: ReportComponent<MetricScatterProps>;
+export type MetricLineProps = DataProps<LineData, MetricLineOptions, ChromeProps & {
+    pointHref?: (row: LineData["rows"][number]) => string;
+}>;
+/** 趋势线:x 是 NumericAxis(参数轴),点身份 = (series, x)。 */
+export declare const MetricLine: ReportComponent<MetricLineProps>;
+export type DeltaTableProps = DataProps<DeltaData, DeltaTableOptions, ChromeProps & {
+    attemptHref?: (locator: AttemptLocator) => string;
+}>;
+/** 成对对比:每行一对(字面声明或 pairsByFlag 派生),格子里 A、B、Δ 三个值。 */
+export declare const DeltaTable: ReportComponent<DeltaTableProps>;
 export {};