@agile-team/mach-report 2.17.0 → 2.18.0

package/dist/server.d.cts

@@ -22,6 +22,22 @@ declare type AggregateOperation = "sum" | "count" | "avg" | "min" | "max" | "wei
 
 declare type AggregateOperation_2 = "sum" | "count" | "avg" | "min" | "max" | "weightedAvg";
 
+declare interface AggregateRequest {
+    op: AggregateOperation;
+    field?: string;
+    weightField?: string;
+    numeric?: "number" | "decimal";
+    digits?: number;
+}
+
+declare interface AggregateRequest_2 {
+    op: AggregateOperation_2;
+    field?: string;
+    weightField?: string;
+    numeric?: "number" | "decimal";
+    digits?: number;
+}
+
 declare interface AssetRenderBudget {
     /** Maximum newly rendered assets, default 1000. Existing imageData is kept unchanged. */
     maxAssets?: number;
@@ -119,6 +135,40 @@ declare type ColumnFormat_2 = {
     pattern?: string;
 };
 
+declare type ColumnVisual = {
+    /** Defaults to the column field; never changes the cell's raw value or business identity. */
+    field?: string;
+    /** Numeric text requires explicit opt-in; formatting an identifier does not turn it into a measure. */
+    numeric?: "number" | "decimal";
+    min?: number;
+    max?: number;
+} & ({
+    kind: "colorScale";
+    lowColor?: string;
+    highColor?: string;
+} | {
+    kind: "dataBar";
+    color?: string;
+    negativeColor?: string;
+});
+
+declare type ColumnVisual_2 = {
+    /** Defaults to the column field; never changes the cell's raw value or business identity. */
+    field?: string;
+    /** Numeric text requires explicit opt-in; formatting an identifier does not turn it into a measure. */
+    numeric?: "number" | "decimal";
+    min?: number;
+    max?: number;
+} & ({
+    kind: "colorScale";
+    lowColor?: string;
+    highColor?: string;
+} | {
+    kind: "dataBar";
+    color?: string;
+    negativeColor?: string;
+});
+
 declare interface ComponentAssetRegistry {
     rendererFor(component: Readonly<PlanComponent>): ComponentImageRenderer | undefined;
     hasExtension(id: string, version: string, kind: string): boolean;
@@ -359,6 +409,12 @@ declare interface FormulaAdapter {
 }
 
 declare interface GridCell {
+    /** Resolved visual only. Original value, text, editability and source are unchanged. */
+    dataBar?: {
+        start: number;
+        end: number;
+        color: string;
+    };
     /** Styled cell content; text remains a plain-text fallback. Imported rich cells are read-only. */
     richParagraphs?: RichParagraph[];
     text?: string;
@@ -385,6 +441,12 @@ declare interface GridCell {
 }
 
 declare interface GridCell_2 {
+    /** Resolved visual only. Original value, text, editability and source are unchanged. */
+    dataBar?: {
+        start: number;
+        end: number;
+        color: string;
+    };
     /** Styled cell content; text remains a plain-text fallback. Imported rich cells are read-only. */
     richParagraphs?: RichParagraph_2[];
     text?: string;
@@ -489,6 +551,8 @@ declare interface ListColumn {
     format?: ColumnFormat;
     /** 条件格式规则（声明式，命中合并进单元格样式；如负数红字） */
     rules?: StyleRule[];
+    /** Optional resolved color scale or value-preserving data bar. */
+    visual?: ColumnVisual;
     /** 内容列编辑控制；仍需由预览显式开启 editing，不影响表头/小计只读规则。 */
     editable?: boolean;
     /** 空值列或特殊数据类型可显式声明编辑输入类型。 */
@@ -515,6 +579,8 @@ declare interface ListColumn_2 {
     format?: ColumnFormat_2;
     /** 条件格式规则（声明式，命中合并进单元格样式；如负数红字） */
     rules?: StyleRule_2[];
+    /** Optional resolved color scale or value-preserving data bar. */
+    visual?: ColumnVisual_2;
     /** 内容列编辑控制；仍需由预览显式开启 editing，不影响表头/小计只读规则。 */
     editable?: boolean;
     /** 空值列或特殊数据类型可显式声明编辑输入类型。 */
@@ -855,6 +921,8 @@ declare interface PaginateOptions {
     maxPages?: number;
     /** Actual grid cells, including repeated furniture and nested children; checked before each page is appended. */
     maxCells?: number;
+    /** Shared bound-chart primitive budget, checked before expansion; default 50000, range 1..1000000. */
+    maxChartComponents?: number;
     signal?: AbortSignal;
     /** Streaming total-page anchors can skip the bounded counting pass when known. */
     knownTotalPages?: number;
@@ -867,6 +935,8 @@ declare interface PaginateOptions {
 export declare function parseReportTemplatePackage(input: unknown, options?: ReportTemplatePackageOptions): ReportTemplatePackage;
 
 declare interface PlanComponent {
+    /** Template-only aggregate binding, expanded into shared primitives during layout. */
+    chartBinding?: ReportChartBinding;
     /** Optional QR/barcode encoding configuration; no encoder is loaded by the core. */
     code?: CodeOptions;
     /** Template-only binding; resolved and removed before constructing the output plan. */
@@ -896,6 +966,8 @@ declare interface PlanComponent {
 }
 
 declare interface PlanComponent_2 {
+    /** Template-only aggregate binding, expanded into shared primitives during layout. */
+    chartBinding?: ReportChartBinding_2;
     /** Optional QR/barcode encoding configuration; no encoder is loaded by the core. */
     code?: CodeOptions_2;
     /** Template-only binding; resolved and removed before constructing the output plan. */
@@ -1121,6 +1193,100 @@ declare interface ReportCellTableIdentity {
 
 declare type ReportCellValue = string | number | boolean | null;
 
+/** Serializable binding; data and authorization continue to come from the existing report source. */
+declare interface ReportChartBinding {
+    dataset: string;
+    categoryField: string;
+    measures: readonly ReportChartMeasure[];
+    type: ReportChartOptions["type"];
+    sort?: "asc" | "desc";
+    title?: string;
+    showValues?: boolean;
+    maxRows?: number;
+    maxCategories?: number;
+}
+
+/** Serializable binding; data and authorization continue to come from the existing report source. */
+declare interface ReportChartBinding_2 {
+    dataset: string;
+    categoryField: string;
+    measures: readonly ReportChartMeasure_2[];
+    type: ReportChartOptions_2["type"];
+    sort?: "asc" | "desc";
+    title?: string;
+    showValues?: boolean;
+    maxRows?: number;
+    maxCategories?: number;
+}
+
+declare interface ReportChartMeasure extends AggregateRequest {
+    label?: string;
+    color?: string;
+}
+
+declare interface ReportChartMeasure_2 extends AggregateRequest_2 {
+    label?: string;
+    color?: string;
+}
+
+declare interface ReportChartOptions {
+    type: "bar" | "line" | "stackedBar" | "percentBar";
+    categories: readonly string[];
+    series: readonly ReportChartSeries[];
+    leftMm: number;
+    topMm: number;
+    widthMm: number;
+    heightMm: number;
+    title?: string;
+    showValues?: boolean;
+}
+
+declare interface ReportChartOptions_2 {
+    type: "bar" | "line" | "stackedBar" | "percentBar";
+    categories: readonly string[];
+    series: readonly ReportChartSeries_2[];
+    leftMm: number;
+    topMm: number;
+    widthMm: number;
+    heightMm: number;
+    title?: string;
+    showValues?: boolean;
+}
+
+declare interface ReportChartSeries {
+    name: string;
+    values: readonly (number | null)[];
+    color?: string;
+}
+
+declare interface ReportChartSeries_2 {
+    name: string;
+    values: readonly (number | null)[];
+    color?: string;
+}
+
+declare interface ReportComparison {
+    field: string;
+    op: ">" | ">=" | "<" | "<=" | "==" | "!=" | "between" | "contains" | "isNull" | "isNotNull";
+    /** Legacy scalar thresholds remain supported. Use right for field-to-field comparisons. */
+    value?: ReportPredicateScalar;
+    right?: ReportPredicateOperand;
+    values?: readonly [ReportPredicateScalar, ReportPredicateScalar];
+    numeric?: "number" | "decimal";
+    valueType?: "number" | "decimal" | "text" | "date" | "boolean";
+}
+
+declare interface ReportComparison_2 {
+    field: string;
+    op: ">" | ">=" | "<" | "<=" | "==" | "!=" | "between" | "contains" | "isNull" | "isNotNull";
+    /** Legacy scalar thresholds remain supported. Use right for field-to-field comparisons. */
+    value?: ReportPredicateScalar_2;
+    right?: ReportPredicateOperand_2;
+    values?: readonly [ReportPredicateScalar_2, ReportPredicateScalar_2];
+    numeric?: "number" | "decimal";
+    valueType?: "number" | "decimal" | "text" | "date" | "boolean";
+}
+
 declare interface ReportDataTarget {
     datasetId: string;
     field: string;
@@ -1221,7 +1387,9 @@ declare type ReportExpression = {
     field?: string;
     weightField?: string;
 } | {
-    op: "add" | "subtract" | "multiply" | "divide" | "coalesce";
+    op: ReportExpressionOperation;
+    /** Required for if; args are [then, else], and only the selected branch is evaluated. */
+    condition?: ReportPredicate;
     args: readonly ReportExpression[];
 };
 
@@ -1234,10 +1402,16 @@ declare type ReportExpression_2 = {
     field?: string;
     weightField?: string;
 } | {
-    op: "add" | "subtract" | "multiply" | "divide" | "coalesce";
+    op: ReportExpressionOperation_2;
+    /** Required for if; args are [then, else], and only the selected branch is evaluated. */
+    condition?: ReportPredicate_2;
     args: readonly ReportExpression_2[];
 };
 
+declare type ReportExpressionOperation = "add" | "subtract" | "multiply" | "divide" | "coalesce" | "if" | "round" | "abs" | "concat" | "trim" | "upper" | "lower" | "dateYear" | "dateMonth" | "dateDay";
+
+declare type ReportExpressionOperation_2 = "add" | "subtract" | "multiply" | "divide" | "coalesce" | "if" | "round" | "abs" | "concat" | "trim" | "upper" | "lower" | "dateYear" | "dateMonth" | "dateDay";
+
 declare type ReportFieldAggregation = "sum" | "avg" | "min" | "max" | "count" | "none";
 
 declare interface ReportFieldCalculation {
@@ -1506,6 +1680,8 @@ declare interface ReportLoadContext {
     signal?: AbortSignal;
 }
 
+declare type ReportNumberRange = readonly [number, number];
+
 export declare interface ReportPackageFixture {
     name: string;
     /** Explicit host confirmation; the SDK does not infer that business values are anonymous. */
@@ -1559,12 +1735,9 @@ declare interface ReportParamDef {
     field: string;
     /** 显示名（缺省用 field） */
     label?: string;
-    type?: "text" | "number" | "date" | "month" | "year" | "dateRange" | "select";
+    type?: "text" | "number" | "date" | "month" | "year" | "dateRange" | "select" | "multiSelect" | "cascader" | "numberRange";
     /** select 选项 */
-    options?: Array<{
-        label: string;
-        value: string;
-    }>;
+    options?: ReportParamTreeOption[];
     /** Opaque host-resolved source key. No URL, credentials or executable code is stored. */
     optionsSource?: string;
     /** Select dependencies must be declared parameters; changing a parent clears descendants. */
@@ -1577,6 +1750,9 @@ declare interface ReportParamDef {
     max?: number | string;
     minLength?: number;
     maxLength?: number;
+    /** multiSelect item count (maximum 100). Cascader paths are bounded to 16 levels. */
+    minItems?: number;
+    maxItems?: number;
 }
 
 /** 报表参数定义（声明式，模板自描述参数面：渲染组件据此生成查询面板） */
@@ -1585,12 +1761,9 @@ declare interface ReportParamDef_2 {
     field: string;
     /** 显示名（缺省用 field） */
     label?: string;
-    type?: "text" | "number" | "date" | "month" | "year" | "dateRange" | "select";
+    type?: "text" | "number" | "date" | "month" | "year" | "dateRange" | "select" | "multiSelect" | "cascader" | "numberRange";
     /** select 选项 */
-    options?: Array<{
-        label: string;
-        value: string;
-    }>;
+    options?: ReportParamTreeOption_2[];
     /** Opaque host-resolved source key. No URL, credentials or executable code is stored. */
     optionsSource?: string;
     /** Select dependencies must be declared parameters; changing a parent clears descendants. */
@@ -1603,6 +1776,9 @@ declare interface ReportParamDef_2 {
     max?: number | string;
     minLength?: number;
     maxLength?: number;
+    /** multiSelect item count (maximum 100). Cascader paths are bounded to 16 levels. */
+    minItems?: number;
+    maxItems?: number;
 }
 
 declare interface ReportParamIssue {
@@ -1612,14 +1788,30 @@ declare interface ReportParamIssue {
     message: string;
 }
 
-declare type ReportParamIssueCode = "definition" | "required" | "type" | "option" | "dependency" | "minimum" | "maximum" | "minLength" | "maxLength";
+declare type ReportParamIssueCode = "definition" | "required" | "type" | "option" | "dependency" | "minimum" | "maximum" | "minLength" | "maxLength" | "minItems" | "maxItems";
+
+/** Cascader values are unique within each sibling list. */
+declare interface ReportParamTreeOption {
+    label: string;
+    value: string;
+    children?: ReportParamTreeOption[];
+}
+
+/** Cascader values are unique within each sibling list. */
+declare interface ReportParamTreeOption_2 {
+    label: string;
+    value: string;
+    children?: ReportParamTreeOption_2[];
+}
+
+declare type ReportParamTypedValue = string | number | string[] | ReportNumberRange;
 
 declare interface ReportParamValidation {
     ok: boolean;
     /** 保留历史取数契约的字符串形式；未知参数保留，不能代替接口权限白名单。 */
     values: Record<string, string>;
     /** JSON Schema 对应的规范值：number 参数转换为有限数字。 */
-    typedValues: Record<string, string | number>;
+    typedValues: Record<string, ReportParamTypedValue>;
     issues: ReportParamIssue[];
 }
 
@@ -1635,6 +1827,38 @@ export declare interface ReportPdfFontOptions {
     };
 }
 
+declare type ReportPredicate = ReportComparison | {
+    all: readonly ReportPredicate[];
+} | {
+    any: readonly ReportPredicate[];
+} | {
+    not: ReportPredicate;
+};
+
+declare type ReportPredicate_2 = ReportComparison_2 | {
+    all: readonly ReportPredicate_2[];
+} | {
+    any: readonly ReportPredicate_2[];
+} | {
+    not: ReportPredicate_2;
+};
+
+declare type ReportPredicateOperand = {
+    field: string;
+} | {
+    value: ReportPredicateScalar;
+};
+
+declare type ReportPredicateOperand_2 = {
+    field: string;
+} | {
+    value: ReportPredicateScalar_2;
+};
+
+declare type ReportPredicateScalar = string | number | boolean | null;
+
+declare type ReportPredicateScalar_2 = string | number | boolean | null;
+
 /** 查询是唯一基础能力；权限、HTTP、数据库和事务都留在宿主适配器内。 */
 declare interface ReportProvider {
     query(context: ReportLoadContext): ReportQueryResult | Promise<ReportQueryResult>;
@@ -1702,6 +1926,8 @@ export declare interface ReportRuntimeBudget {
     maxRows?: number;
     maxPages?: number;
     maxCells?: number;
+    /** Aggregate bound-chart primitives per prepare, before expansion; default 50000, hard maximum 1000000. */
+    maxChartComponents?: number;
     maxOutputBytes?: number;
     /** Bound the plain JSON snapshot accepted by exportPrepared (default 64 MB). */
     maxPreparedBytes?: number;
@@ -1730,6 +1956,7 @@ export declare interface ReportRuntimeExportInput extends ReportRuntimeInput {
         sheetMode?: "auto" | "pages" | "continuous";
         valueMode?: "text" | "raw";
         paperSize?: "auto" | "a3" | "a4" | "a5";
+        maxDataBars?: number;
         sheetName?: (sheetIndex: number) => string;
     };
 }
@@ -2210,26 +2437,14 @@ export declare function snapshotReportInstance(value: ReportInstanceSnapshot, ma
 
 /** 条件格式规则求值（声明式，见 ListColumn.rules） */
 declare interface StyleRule {
-    when: {
-        field: string;
-        op: ">" | ">=" | "<" | "<=" | "==" | "!=";
-        value: number | string;
-        /** Explicit decimal comparisons retain decimal thresholds as text. */
-        numeric?: "number" | "decimal";
-    };
+    when: ReportPredicate;
     /** 命中时合并进单元格样式（color/bold/backgroundColor 等） */
     style: Record<string, unknown>;
 }
 
 /** 条件格式规则求值（声明式，见 ListColumn.rules） */
 declare interface StyleRule_2 {
-    when: {
-        field: string;
-        op: ">" | ">=" | "<" | "<=" | "==" | "!=";
-        value: number | string;
-        /** Explicit decimal comparisons retain decimal thresholds as text. */
-        numeric?: "number" | "decimal";
-    };
+    when: ReportPredicate_2;
     /** 命中时合并进单元格样式（color/bold/backgroundColor 等） */
     style: Record<string, unknown>;
 }