@agile-team/mach-report 2.3.1 → 2.4.0

package/dist/xlsx.d.cts

@@ -341,6 +341,29 @@ declare interface Column {
     	defn: any; //todo
 }
 
+/**
+ * 列值格式化（声明式、JSON 可序列化）。
+ * 在 paginate 的 cellText 出口统一消费：格式化发生在进 RenderPlan 之前，
+ * 三后端（DOM/Canvas/PDF）零改动。
+ *
+ * 语义约定（v0.9 固化）：
+ * - number.digits 显式给出 → 精确保留（12.5 + digits:2 → "12.50"）
+ * - number.thousands 默认 false（千分位显式开启）
+ * - date 字符串按"本地时区的日历日"解析（YYYY-MM-DD / YYYY/MM/DD 直取年月日，
+ *   不经 Date 字符串构造——后者按 UTC 零点，负时区环境会少一天）
+ */
+declare type ColumnFormat = {
+    kind: "number";
+    thousands?: boolean;
+    digits?: number;
+} | {
+    kind: "percent";
+    digits?: number;
+} | {
+    kind: "date";
+    pattern?: string;
+};
+
 declare interface Comment_2 {
     		texts?: RichText[];
     		margins?: Partial<CommentMargins>;
@@ -540,6 +563,55 @@ declare enum ErrorValue {
     	Num = '#NUM!',
 }
 
+export declare interface ExcelImportedSheet {
+    name: string;
+    /** Original, one-based workbook position. */
+    index: number;
+    range: string;
+    rowCount: number;
+    columnCount: number;
+    /** Zero-based index into template.pages. */
+    pageStart: number;
+    pageCount: number;
+}
+
+/** Limits apply to the selected rectangular ranges, including their empty cells. */
+export declare interface ExcelImportLimits {
+    /** Compressed input, default 20 MiB. */
+    maxFileBytes?: number;
+    /** Declared ZIP uncompressed total, default 64 MiB. */
+    maxUncompressedBytes?: number;
+    /** Total selected cells across sheets, default 250,000; hard ceiling 1,000,000. */
+    maxCells?: number;
+    /** Rows per selected sheet, default 100,000; hard ceiling 1,048,576. */
+    maxRows?: number;
+    /** Columns per selected sheet, default 2,048; hard ceiling 16,384. */
+    maxColumns?: number;
+    /** Workbook sheets, default 32. */
+    maxSheets?: number;
+}
+
+export declare interface ExcelImportOptions {
+    /** Sheet names or one-based workbook positions. Default: all visible sheets. */
+    sheets?: Array<string | number>;
+    /** A1 range for every sheet, or ranges keyed by exact sheet name. */
+    range?: string | Record<string, string>;
+    /** Wide preserves natural column widths. A3/A4 scale the complete width to paper. */
+    layout?: "wide" | "a3" | "a4";
+    /** Only applies to A3/A4; default landscape. */
+    landscape?: boolean;
+    /** Vertical preview segment limit, default 80, maximum 200. Merges remain intact. */
+    maxRowsPerPage?: number;
+    /** Optional resource limits; hard ceilings prevent unbounded allocations. */
+    limits?: ExcelImportLimits;
+}
+
+export declare interface ExcelImportResult {
+    template: ReportTemplate;
+    warnings: string[];
+    sheets: ExcelImportedSheet[];
+}
+
 declare namespace ExcelJS {
     export {
         Buffer_2 as Buffer,
@@ -790,6 +862,12 @@ declare interface GridCell {
     value?: string | number | boolean | null;
     /** Excel 数字格式（例如 #,##0.00 / 0.00%），不改变 text。 */
     numberFormat?: string;
+    /** 编辑输入类型；省略时只按原始值推断，数字字符串不会被转换为数值。 */
+    valueType?: "text" | "number" | "boolean";
+    /** 单元格级编辑控制；预览仍需显式开启 editing。 */
+    editable?: boolean;
+    /** Excel 公式保留元数据；当前引擎不计算公式，公式格始终只读。 */
+    formula?: string;
     children?: PlanComponent[];
     colSpan?: number;
     rowSpan?: number;
@@ -879,6 +957,12 @@ declare interface ImageRange {
     	br: Anchor;
 }
 
+/**
+ * Import saved .xlsx cell values and common styles as a reusable JSON report template.
+ * No formulas, macros, links, database calls or scripts are evaluated. The workbook is not modified.
+ */
+export declare function importExcelTemplate(input: ArrayBuffer | Uint8Array | Blob, options?: ExcelImportOptions): Promise<ExcelImportResult>;
+
 declare interface JSZipGeneratorOptions {
     	/**
      	 * @default DEFLATE
@@ -892,6 +976,82 @@ declare interface JSZipGeneratorOptions {
         	};
 }
 
+/** auto：真实数字/显式数值格式居右，日期与布尔居中，其他内容居左。 */
+declare type ListAlignment = NonNullable<ComponentStyle["align"]> | "auto";
+
+declare interface ListColumn {
+    header: string;
+    field: string;
+    widthMm: number;
+    style?: ComponentStyle;
+    /** 内容对齐，优先于 style.align；数值字符串不会自动判为数字。 */
+    align?: ListAlignment;
+    /** 独立的表头对齐，不改变内容对齐。 */
+    headerAlign?: ComponentStyle["align"];
+    /** 独立的表头样式，优先于列表级表头样式。 */
+    headerStyle?: ComponentStyle;
+    /** 值格式化（声明式）：千分位/小数位、百分比、日期 pattern */
+    format?: ColumnFormat;
+    /** 条件格式规则（声明式，命中合并进单元格样式；如负数红字） */
+    rules?: StyleRule[];
+    /** 内容列编辑控制；仍需由预览显式开启 editing，不影响表头/小计只读规则。 */
+    editable?: boolean;
+    /** 空值列或特殊数据类型可显式声明编辑输入类型。 */
+    valueType?: GridCell["valueType"];
+}
+
+declare interface ListComponent {
+    kind: "list";
+    id?: string;
+    /** 宽表标记用于连续 Excel；不改变低层列表的列宽和分页算法。 */
+    layout?: "page" | "wide";
+    /** 逻辑表名称，供 Excel Sheet 命名；不额外生成标题组件。 */
+    title?: string;
+    leftMm: number;
+    topMm: number;
+    widthMm: number;
+    dataset: string;
+    columns: ListColumn[];
+    fontSizePt?: number;
+    headerBold?: boolean;
+    rowHeightMm?: number;
+    paddingMm?: number;
+    headerEveryPage?: boolean;
+    headerBackgroundColor?: string;
+    /** 内容默认对齐，列配置可覆盖；低层模板缺省仍为 left。 */
+    align?: ListAlignment;
+    /** 表头默认对齐，列配置可覆盖。 */
+    headerAlign?: ComponentStyle["align"];
+    headerStyle?: ComponentStyle;
+    border?: boolean;
+    /** 分组小计（组头/组尾小计/组头防孤行） */
+    groupBy?: ListGroupBy;
+    /** 末尾总合计行（依赖 groupBy.subtotal 或显式 fields） */
+    grandTotal?: ListGrandTotal;
+}
+
+declare type ListGrandTotal = boolean | {
+    label?: string;
+    style?: ComponentStyle;
+    /** 合计列（缺省沿用 groupBy.subtotal） */
+    fields?: string[];
+};
+
+/** 分组小计配置（声明式，见 ListComponent.groupBy） */
+declare interface ListGroupBy {
+    /** 分组字段（值变化即切组） */
+    field: string;
+    /** 组头文案模板，{value} 占位（默认 "{value}"） */
+    headerTemplate?: string;
+    headerStyle?: ComponentStyle;
+    /** 需要小计的列字段（组尾输出合计行；数值列求和，其余输出首值/留空） */
+    subtotal?: string[];
+    subtotalStyle?: ComponentStyle;
+    subtotalLabel?: string;
+    /** 组头防孤行（默认 true：页尾放不下"组头+首行"时整体换页） */
+    keepWithNext?: boolean;
+}
+
 declare interface Location_2 {
     	top: number;
     	left: number;
@@ -1216,6 +1376,30 @@ declare interface RenderPlan {
 
 export declare function renderPlanToXlsx(plan: RenderPlan, options?: XlsxRenderOptions): Promise<XlsxRenderResult>;
 
+/** 报表参数定义（声明式，模板自描述参数面：渲染组件据此生成查询面板） */
+declare interface ReportParamDef {
+    /** 参数名（传入 params，与数据集 SQL #{field} 绑定对应） */
+    field: string;
+    /** 显示名（缺省用 field） */
+    label?: string;
+    type?: "text" | "number" | "date" | "select";
+    /** select 选项 */
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    defaultValue?: string;
+    required?: boolean;
+    placeholder?: string;
+}
+
+declare interface ReportTemplate {
+    schemaVersion?: string;
+    /** 参数定义（可选；宿主也可经 ReportPreview 的 paramDefs prop 提供，prop 优先） */
+    params?: ReportParamDef[];
+    pages: TemplatePage[];
+}
+
 declare interface RichParagraph {
     segments: RichSegment[];
     align?: ComponentStyle["align"];
@@ -1491,6 +1675,17 @@ declare interface Style {
     	fill: Fill;
 }
 
+/** 条件格式规则求值（声明式，见 ListColumn.rules） */
+declare interface StyleRule {
+    when: {
+        field: string;
+        op: ">" | ">=" | "<" | "<=" | "==" | "!=";
+        value: number | string;
+    };
+    /** 命中时合并进单元格样式（color/bold/backgroundColor 等） */
+    style: Record<string, unknown>;
+}
+
 declare interface Table extends Required<TableProperties> {
     	/**
      	 * Commit changes
@@ -1613,6 +1808,20 @@ declare interface TableStyleProperties {
     	showColumnStripes?: boolean;
 }
 
+declare type TemplateComponent = PlanComponent | ListComponent;
+
+declare interface TemplatePage {
+    widthMm: number;
+    heightMm: number;
+    /** 宽表保持全列自然宽度，页高只控制内部纵向分段。 */
+    layout?: "page" | "wide";
+    marginTopMm?: number;
+    marginBottomMm?: number;
+    marginLeftMm?: number;
+    marginRightMm?: number;
+    components: TemplateComponent[];
+}
+
 declare interface TimePeriodRuleType extends ConditionalFormattingBaseRule {
     	type: 'timePeriod';
     	timePeriod?: TimePeriodTypes;

package/dist/xlsx.d.ts

@@ -341,6 +341,29 @@ declare interface Column {
     	defn: any; //todo
 }
 
+/**
+ * 列值格式化（声明式、JSON 可序列化）。
+ * 在 paginate 的 cellText 出口统一消费：格式化发生在进 RenderPlan 之前，
+ * 三后端（DOM/Canvas/PDF）零改动。
+ *
+ * 语义约定（v0.9 固化）：
+ * - number.digits 显式给出 → 精确保留（12.5 + digits:2 → "12.50"）
+ * - number.thousands 默认 false（千分位显式开启）
+ * - date 字符串按"本地时区的日历日"解析（YYYY-MM-DD / YYYY/MM/DD 直取年月日，
+ *   不经 Date 字符串构造——后者按 UTC 零点，负时区环境会少一天）
+ */
+declare type ColumnFormat = {
+    kind: "number";
+    thousands?: boolean;
+    digits?: number;
+} | {
+    kind: "percent";
+    digits?: number;
+} | {
+    kind: "date";
+    pattern?: string;
+};
+
 declare interface Comment_2 {
     		texts?: RichText[];
     		margins?: Partial<CommentMargins>;
@@ -540,6 +563,55 @@ declare enum ErrorValue {
     	Num = '#NUM!',
 }
 
+export declare interface ExcelImportedSheet {
+    name: string;
+    /** Original, one-based workbook position. */
+    index: number;
+    range: string;
+    rowCount: number;
+    columnCount: number;
+    /** Zero-based index into template.pages. */
+    pageStart: number;
+    pageCount: number;
+}
+
+/** Limits apply to the selected rectangular ranges, including their empty cells. */
+export declare interface ExcelImportLimits {
+    /** Compressed input, default 20 MiB. */
+    maxFileBytes?: number;
+    /** Declared ZIP uncompressed total, default 64 MiB. */
+    maxUncompressedBytes?: number;
+    /** Total selected cells across sheets, default 250,000; hard ceiling 1,000,000. */
+    maxCells?: number;
+    /** Rows per selected sheet, default 100,000; hard ceiling 1,048,576. */
+    maxRows?: number;
+    /** Columns per selected sheet, default 2,048; hard ceiling 16,384. */
+    maxColumns?: number;
+    /** Workbook sheets, default 32. */
+    maxSheets?: number;
+}
+
+export declare interface ExcelImportOptions {
+    /** Sheet names or one-based workbook positions. Default: all visible sheets. */
+    sheets?: Array<string | number>;
+    /** A1 range for every sheet, or ranges keyed by exact sheet name. */
+    range?: string | Record<string, string>;
+    /** Wide preserves natural column widths. A3/A4 scale the complete width to paper. */
+    layout?: "wide" | "a3" | "a4";
+    /** Only applies to A3/A4; default landscape. */
+    landscape?: boolean;
+    /** Vertical preview segment limit, default 80, maximum 200. Merges remain intact. */
+    maxRowsPerPage?: number;
+    /** Optional resource limits; hard ceilings prevent unbounded allocations. */
+    limits?: ExcelImportLimits;
+}
+
+export declare interface ExcelImportResult {
+    template: ReportTemplate;
+    warnings: string[];
+    sheets: ExcelImportedSheet[];
+}
+
 declare namespace ExcelJS {
     export {
         Buffer_2 as Buffer,
@@ -790,6 +862,12 @@ declare interface GridCell {
     value?: string | number | boolean | null;
     /** Excel 数字格式（例如 #,##0.00 / 0.00%），不改变 text。 */
     numberFormat?: string;
+    /** 编辑输入类型；省略时只按原始值推断，数字字符串不会被转换为数值。 */
+    valueType?: "text" | "number" | "boolean";
+    /** 单元格级编辑控制；预览仍需显式开启 editing。 */
+    editable?: boolean;
+    /** Excel 公式保留元数据；当前引擎不计算公式，公式格始终只读。 */
+    formula?: string;
     children?: PlanComponent[];
     colSpan?: number;
     rowSpan?: number;
@@ -879,6 +957,12 @@ declare interface ImageRange {
     	br: Anchor;
 }
 
+/**
+ * Import saved .xlsx cell values and common styles as a reusable JSON report template.
+ * No formulas, macros, links, database calls or scripts are evaluated. The workbook is not modified.
+ */
+export declare function importExcelTemplate(input: ArrayBuffer | Uint8Array | Blob, options?: ExcelImportOptions): Promise<ExcelImportResult>;
+
 declare interface JSZipGeneratorOptions {
     	/**
      	 * @default DEFLATE
@@ -892,6 +976,82 @@ declare interface JSZipGeneratorOptions {
         	};
 }
 
+/** auto：真实数字/显式数值格式居右，日期与布尔居中，其他内容居左。 */
+declare type ListAlignment = NonNullable<ComponentStyle["align"]> | "auto";
+
+declare interface ListColumn {
+    header: string;
+    field: string;
+    widthMm: number;
+    style?: ComponentStyle;
+    /** 内容对齐，优先于 style.align；数值字符串不会自动判为数字。 */
+    align?: ListAlignment;
+    /** 独立的表头对齐，不改变内容对齐。 */
+    headerAlign?: ComponentStyle["align"];
+    /** 独立的表头样式，优先于列表级表头样式。 */
+    headerStyle?: ComponentStyle;
+    /** 值格式化（声明式）：千分位/小数位、百分比、日期 pattern */
+    format?: ColumnFormat;
+    /** 条件格式规则（声明式，命中合并进单元格样式；如负数红字） */
+    rules?: StyleRule[];
+    /** 内容列编辑控制；仍需由预览显式开启 editing，不影响表头/小计只读规则。 */
+    editable?: boolean;
+    /** 空值列或特殊数据类型可显式声明编辑输入类型。 */
+    valueType?: GridCell["valueType"];
+}
+
+declare interface ListComponent {
+    kind: "list";
+    id?: string;
+    /** 宽表标记用于连续 Excel；不改变低层列表的列宽和分页算法。 */
+    layout?: "page" | "wide";
+    /** 逻辑表名称，供 Excel Sheet 命名；不额外生成标题组件。 */
+    title?: string;
+    leftMm: number;
+    topMm: number;
+    widthMm: number;
+    dataset: string;
+    columns: ListColumn[];
+    fontSizePt?: number;
+    headerBold?: boolean;
+    rowHeightMm?: number;
+    paddingMm?: number;
+    headerEveryPage?: boolean;
+    headerBackgroundColor?: string;
+    /** 内容默认对齐，列配置可覆盖；低层模板缺省仍为 left。 */
+    align?: ListAlignment;
+    /** 表头默认对齐，列配置可覆盖。 */
+    headerAlign?: ComponentStyle["align"];
+    headerStyle?: ComponentStyle;
+    border?: boolean;
+    /** 分组小计（组头/组尾小计/组头防孤行） */
+    groupBy?: ListGroupBy;
+    /** 末尾总合计行（依赖 groupBy.subtotal 或显式 fields） */
+    grandTotal?: ListGrandTotal;
+}
+
+declare type ListGrandTotal = boolean | {
+    label?: string;
+    style?: ComponentStyle;
+    /** 合计列（缺省沿用 groupBy.subtotal） */
+    fields?: string[];
+};
+
+/** 分组小计配置（声明式，见 ListComponent.groupBy） */
+declare interface ListGroupBy {
+    /** 分组字段（值变化即切组） */
+    field: string;
+    /** 组头文案模板，{value} 占位（默认 "{value}"） */
+    headerTemplate?: string;
+    headerStyle?: ComponentStyle;
+    /** 需要小计的列字段（组尾输出合计行；数值列求和，其余输出首值/留空） */
+    subtotal?: string[];
+    subtotalStyle?: ComponentStyle;
+    subtotalLabel?: string;
+    /** 组头防孤行（默认 true：页尾放不下"组头+首行"时整体换页） */
+    keepWithNext?: boolean;
+}
+
 declare interface Location_2 {
     	top: number;
     	left: number;
@@ -1216,6 +1376,30 @@ declare interface RenderPlan {
 
 export declare function renderPlanToXlsx(plan: RenderPlan, options?: XlsxRenderOptions): Promise<XlsxRenderResult>;
 
+/** 报表参数定义（声明式，模板自描述参数面：渲染组件据此生成查询面板） */
+declare interface ReportParamDef {
+    /** 参数名（传入 params，与数据集 SQL #{field} 绑定对应） */
+    field: string;
+    /** 显示名（缺省用 field） */
+    label?: string;
+    type?: "text" | "number" | "date" | "select";
+    /** select 选项 */
+    options?: Array<{
+        label: string;
+        value: string;
+    }>;
+    defaultValue?: string;
+    required?: boolean;
+    placeholder?: string;
+}
+
+declare interface ReportTemplate {
+    schemaVersion?: string;
+    /** 参数定义（可选；宿主也可经 ReportPreview 的 paramDefs prop 提供，prop 优先） */
+    params?: ReportParamDef[];
+    pages: TemplatePage[];
+}
+
 declare interface RichParagraph {
     segments: RichSegment[];
     align?: ComponentStyle["align"];
@@ -1491,6 +1675,17 @@ declare interface Style {
     	fill: Fill;
 }
 
+/** 条件格式规则求值（声明式，见 ListColumn.rules） */
+declare interface StyleRule {
+    when: {
+        field: string;
+        op: ">" | ">=" | "<" | "<=" | "==" | "!=";
+        value: number | string;
+    };
+    /** 命中时合并进单元格样式（color/bold/backgroundColor 等） */
+    style: Record<string, unknown>;
+}
+
 declare interface Table extends Required<TableProperties> {
     	/**
      	 * Commit changes
@@ -1613,6 +1808,20 @@ declare interface TableStyleProperties {
     	showColumnStripes?: boolean;
 }
 
+declare type TemplateComponent = PlanComponent | ListComponent;
+
+declare interface TemplatePage {
+    widthMm: number;
+    heightMm: number;
+    /** 宽表保持全列自然宽度，页高只控制内部纵向分段。 */
+    layout?: "page" | "wide";
+    marginTopMm?: number;
+    marginBottomMm?: number;
+    marginLeftMm?: number;
+    marginRightMm?: number;
+    components: TemplateComponent[];
+}
+
 declare interface TimePeriodRuleType extends ConditionalFormattingBaseRule {
     	type: 'timePeriod';
     	timePeriod?: TimePeriodTypes;