@agile-team/mach-report 2.4.0 → 2.5.0

package/dist/vue/async.d.ts

@@ -450,6 +450,9 @@ declare interface MachReportDefaults {
     showExport?: boolean;
     showPrint?: boolean;
     showPdfWindow?: boolean;
+    /** 设置入口默认显示；可在其中按需启用阅读及输出工具。 */
+    showSettings?: boolean;
+    toolbar?: MachReportToolbarOptions;
     /** 参数面板显隐（有参数定义且未显式关闭时显示；缺省 true） */
     showParams?: boolean;
     /** 页间距 px */
@@ -533,6 +536,20 @@ declare interface MachReportMessages {
     editInvalidNumber?: string;
     editInvalidBoolean?: string;
     editConflict?: string;
+    settings?: string;
+    settingsDisplay?: string;
+    settingsExport?: string;
+    settingsData?: string;
+    settingsUnavailable?: string;
+    settingsReset?: string;
+    settingsClose?: string;
+    search?: string;
+    zoom?: string;
+    settingsLocal?: string;
+    editingLocal?: string;
+    editingSaved?: string;
+    importLocal?: string;
+    emptyDescription?: string;
 }
 
 declare interface MachReportPluginOptions {
@@ -586,6 +603,18 @@ export declare const MachReportPreview: {
     type: BooleanConstructor;
     default: undefined;
     };
+    showSettings: {
+    type: BooleanConstructor;
+    default: undefined;
+    };
+    toolbar: {
+    type: PropType<MachReportToolbarOptions>;
+    default: undefined;
+    };
+    emptyState: {
+    type: PropType<boolean | ReportEmptyState>;
+    default: boolean;
+    };
     gapPx: {
     type: NumberConstructor;
     default: undefined;
@@ -631,6 +660,7 @@ export declare const MachReportPreview: {
     onWarning?: ((message: string) => any) | undefined;
     "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
     "onTemplate-import"?: ((result: ExcelImportResult) => any) | undefined;
+    "onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
     }>, {
     reload: () => Promise<void>;
     print: () => Promise<void>;
@@ -654,6 +684,7 @@ export declare const MachReportPreview: {
     warning: (message: string) => any;
     "cell-edit": (edit: ReportCellEdit_2) => any;
     "template-import": (result: ExcelImportResult) => any;
+    "preferences-change": (preferences: Readonly<ReportPreviewPreferences>) => any;
     }, PublicProps, {
     editable: boolean | ReportEditingOptions;
     height: string;
@@ -664,10 +695,13 @@ export declare const MachReportPreview: {
     showExport: boolean;
     showPrint: boolean;
     showPdfWindow: boolean;
+    showSettings: boolean;
     showParams: boolean;
+    toolbar: MachReportToolbarOptions;
     messages: Partial<MachReportMessages>;
     excelImport: boolean | ExcelImportOptions_2;
     autoLoad: boolean;
+    emptyState: boolean | ReportEmptyState;
     preset: string;
     paramDefs: ReportParamDef[] | undefined;
     fetcher: PlanFetcher | null;
@@ -712,6 +746,18 @@ export declare const MachReportPreview: {
     type: BooleanConstructor;
     default: undefined;
     };
+    showSettings: {
+    type: BooleanConstructor;
+    default: undefined;
+    };
+    toolbar: {
+    type: PropType<MachReportToolbarOptions>;
+    default: undefined;
+    };
+    emptyState: {
+    type: PropType<boolean | ReportEmptyState>;
+    default: boolean;
+    };
     gapPx: {
     type: NumberConstructor;
     default: undefined;
@@ -757,6 +803,7 @@ export declare const MachReportPreview: {
     onWarning?: ((message: string) => any) | undefined;
     "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
     "onTemplate-import"?: ((result: ExcelImportResult) => any) | undefined;
+    "onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
     }>, {
     reload: () => Promise<void>;
     print: () => Promise<void>;
@@ -781,10 +828,13 @@ export declare const MachReportPreview: {
     showExport: boolean;
     showPrint: boolean;
     showPdfWindow: boolean;
+    showSettings: boolean;
     showParams: boolean;
+    toolbar: MachReportToolbarOptions;
     messages: Partial<MachReportMessages>;
     excelImport: boolean | ExcelImportOptions_2;
     autoLoad: boolean;
+    emptyState: boolean | ReportEmptyState;
     preset: string;
     paramDefs: ReportParamDef[] | undefined;
     fetcher: PlanFetcher | null;
@@ -821,6 +871,18 @@ showPdfWindow: {
 type: BooleanConstructor;
 default: undefined;
 };
+showSettings: {
+type: BooleanConstructor;
+default: undefined;
+};
+toolbar: {
+type: PropType<MachReportToolbarOptions>;
+default: undefined;
+};
+emptyState: {
+type: PropType<boolean | ReportEmptyState>;
+default: boolean;
+};
 gapPx: {
 type: NumberConstructor;
 default: undefined;
@@ -866,6 +928,7 @@ onLoaded?: ((pageCount: number) => any) | undefined;
 onWarning?: ((message: string) => any) | undefined;
 "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
 "onTemplate-import"?: ((result: ExcelImportResult) => any) | undefined;
+"onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
 }>, {
 reload: () => Promise<void>;
 print: () => Promise<void>;
@@ -889,6 +952,7 @@ loaded: (pageCount: number) => any;
 warning: (message: string) => any;
 "cell-edit": (edit: ReportCellEdit_2) => any;
 "template-import": (result: ExcelImportResult) => any;
+"preferences-change": (preferences: Readonly<ReportPreviewPreferences>) => any;
 }, string, {
 editable: boolean | ReportEditingOptions;
 height: string;
@@ -899,15 +963,19 @@ debug: boolean;
 showExport: boolean;
 showPrint: boolean;
 showPdfWindow: boolean;
+showSettings: boolean;
 showParams: boolean;
+toolbar: MachReportToolbarOptions;
 messages: Partial<MachReportMessages>;
 excelImport: boolean | ExcelImportOptions_2;
 autoLoad: boolean;
+emptyState: boolean | ReportEmptyState;
 preset: string;
 paramDefs: ReportParamDef[] | undefined;
 fetcher: PlanFetcher | null;
 }, {}, string, {}, { [K in keyof GlobalComponents]: GlobalComponents[K] }, { [K in keyof GlobalDirectives]: GlobalDirectives[K] }, string, ComponentProvideOptions> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
+        settings?(_: {}): any;
         default?(_: {}): any;
     };
 });
@@ -959,6 +1027,18 @@ declare interface MachReportTheme {
     btnActiveBg: string;
 }
 
+declare interface MachReportToolbarOptions {
+    search?: boolean;
+    thumbnails?: boolean;
+    zoom?: boolean;
+    /** 编辑能力由 editable 授权；此项仅设置初始交互偏好，默认 true（兼容旧行为）。 */
+    editing?: boolean;
+    /** 导入能力由 excelImport 授权；此项仅设置初始交互偏好，默认 true。 */
+    excelImport?: boolean;
+    /** 未传时显示全部已有出口；空数组表示不提供导出工具。 */
+    exportFormats?: ReportExportFormat[];
+}
+
 declare interface PaginateOptions {
     /** 每行额外占高（mm），压测专用钩子 */
     mmPerRow?: number;
@@ -1140,6 +1220,8 @@ declare interface RenderPlan {
     pages: PlanPage[];
 }
 
+declare const REPORT_PREVIEW_TOOLS: readonly ["search", "thumbnails", "zoom", ...ReportExportFormat[], "print", "pdfWindow", "editing", "import"];
+
 /** 预览中的物理坐标；合并单元格使用左上角坐标。 */
 declare interface ReportCellAddress {
     pageIndex: number;
@@ -1234,6 +1316,15 @@ declare interface ReportEditOperation {
     signal: AbortSignal;
 }
 
+/** 报表含表头但业务行为空时，由接入方明确声明；组件不推测业务数据。 */
+declare interface ReportEmptyState {
+    title?: string;
+    description?: string;
+}
+
+/** 输出能力仍由宿主授权；工具偏好只决定当前预览实例的可见与启用状态。 */
+declare type ReportExportFormat = "html" | "pdf" | "xlsx" | "png" | "word";
+
 /** 保持 Promise<RenderPlan> 契约；元数据为可选，旧业务 fetcher 无需改造。 */
 declare interface ReportFetcher {
     (input: ReportFetchInput): Promise<RenderPlan>;
@@ -1286,6 +1377,10 @@ declare interface ReportParamDef_2 {
     placeholder?: string;
 }
 
+declare type ReportPreviewPreferences = Record<ReportPreviewTool, boolean>;
+
+declare type ReportPreviewTool = typeof REPORT_PREVIEW_TOOLS[number];
+
 declare type ReportRegistry = Record<string, ReportDefinition>;
 
 declare interface ReportTemplate {

package/dist/vue/index.d.cts

@@ -48,6 +48,19 @@ showPdfWindow: {
 type: BooleanConstructor;
 default: undefined;
 };
+showSettings: {
+type: BooleanConstructor;
+default: undefined;
+};
+toolbar: {
+type: PropType<MachReportToolbarOptions>;
+default: undefined;
+};
+/** 保留表头的零行业务结果；不改变计划和导出内容。 */
+emptyState: {
+type: PropType<boolean | ReportEmptyState>;
+default: boolean;
+};
 /** 页间距（px）；不传走配置中心 */
 gapPx: {
 type: NumberConstructor;
@@ -111,6 +124,7 @@ loaded: (pageCount: number) => any;
 warning: (message: string) => any;
 "cell-edit": (edit: ReportCellEdit_2) => any;
 "template-import": (result: ExcelImportResult) => any;
+"preferences-change": (preferences: Readonly<ReportPreviewPreferences>) => any;
 }, string, PublicProps, Readonly<ExtractPropTypes<    {
 reportId: {
 type: PropType<string | string[] | null>;
@@ -141,6 +155,19 @@ showPdfWindow: {
 type: BooleanConstructor;
 default: undefined;
 };
+showSettings: {
+type: BooleanConstructor;
+default: undefined;
+};
+toolbar: {
+type: PropType<MachReportToolbarOptions>;
+default: undefined;
+};
+/** 保留表头的零行业务结果；不改变计划和导出内容。 */
+emptyState: {
+type: PropType<boolean | ReportEmptyState>;
+default: boolean;
+};
 /** 页间距（px）；不传走配置中心 */
 gapPx: {
 type: NumberConstructor;
@@ -192,6 +219,7 @@ onLoaded?: ((pageCount: number) => any) | undefined;
 onWarning?: ((message: string) => any) | undefined;
 "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
 "onTemplate-import"?: ((result: ExcelImportResult) => any) | undefined;
+"onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
 }>, {
 editable: boolean | ReportEditingOptions;
 height: string;
@@ -202,10 +230,13 @@ debug: boolean;
 showExport: boolean;
 showPrint: boolean;
 showPdfWindow: boolean;
+showSettings: boolean;
 showParams: boolean;
+toolbar: MachReportToolbarOptions;
 messages: Partial<MachReportMessages>;
 excelImport: boolean | ExcelImportOptions;
 autoLoad: boolean;
+emptyState: boolean | ReportEmptyState;
 preset: string;
 paramDefs: ReportParamDef[] | undefined;
 fetcher: PlanFetcher | null;
@@ -234,6 +265,12 @@ declare type __VLS_Props = {
     };
     thumbsVisible: boolean;
     showImport?: boolean;
+    showSearch?: boolean;
+    showThumbnails?: boolean;
+    showZoom?: boolean;
+    exportFormats?: readonly ReportExportFormat[];
+    showSettings?: boolean;
+    settingsOpen?: boolean;
     busy?: boolean;
 };
 
@@ -248,6 +285,7 @@ declare type __VLS_Props_2 = {
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
+        settings?(_: {}): any;
         default?(_: {}): any;
     };
     refs: {
@@ -944,6 +982,9 @@ export declare interface MachReportDefaults {
     showExport?: boolean;
     showPrint?: boolean;
     showPdfWindow?: boolean;
+    /** 设置入口默认显示；可在其中按需启用阅读及输出工具。 */
+    showSettings?: boolean;
+    toolbar?: MachReportToolbarOptions;
     /** 参数面板显隐（有参数定义且未显式关闭时显示；缺省 true） */
     showParams?: boolean;
     /** 页间距 px */
@@ -1054,6 +1095,20 @@ export declare interface MachReportMessages {
     editInvalidNumber?: string;
     editInvalidBoolean?: string;
     editConflict?: string;
+    settings?: string;
+    settingsDisplay?: string;
+    settingsExport?: string;
+    settingsData?: string;
+    settingsUnavailable?: string;
+    settingsReset?: string;
+    settingsClose?: string;
+    search?: string;
+    zoom?: string;
+    settingsLocal?: string;
+    editingLocal?: string;
+    editingSaved?: string;
+    importLocal?: string;
+    emptyDescription?: string;
 }
 
 /**
@@ -1121,6 +1176,18 @@ export declare const MachReportPreview: {
     type: BooleanConstructor;
     default: undefined;
     };
+    showSettings: {
+    type: BooleanConstructor;
+    default: undefined;
+    };
+    toolbar: {
+    type: PropType<MachReportToolbarOptions>;
+    default: undefined;
+    };
+    emptyState: {
+    type: PropType<boolean | ReportEmptyState>;
+    default: boolean;
+    };
     gapPx: {
     type: NumberConstructor;
     default: undefined;
@@ -1166,6 +1233,7 @@ export declare const MachReportPreview: {
     onWarning?: ((message: string) => any) | undefined;
     "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
     "onTemplate-import"?: ((result: ExcelImportResult_2) => any) | undefined;
+    "onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
     }>, {
     reload: () => Promise<void>;
     print: () => Promise<void>;
@@ -1189,6 +1257,7 @@ export declare const MachReportPreview: {
     warning: (message: string) => any;
     "cell-edit": (edit: ReportCellEdit_2) => any;
     "template-import": (result: ExcelImportResult_2) => any;
+    "preferences-change": (preferences: Readonly<ReportPreviewPreferences>) => any;
     }, PublicProps, {
     editable: boolean | ReportEditingOptions;
     height: string;
@@ -1199,10 +1268,13 @@ export declare const MachReportPreview: {
     showExport: boolean;
     showPrint: boolean;
     showPdfWindow: boolean;
+    showSettings: boolean;
     showParams: boolean;
+    toolbar: MachReportToolbarOptions;
     messages: Partial<MachReportMessages>;
     excelImport: boolean | ExcelImportOptions_2;
     autoLoad: boolean;
+    emptyState: boolean | ReportEmptyState;
     preset: string;
     paramDefs: ReportParamDef[] | undefined;
     fetcher: PlanFetcher | null;
@@ -1247,6 +1319,18 @@ export declare const MachReportPreview: {
     type: BooleanConstructor;
     default: undefined;
     };
+    showSettings: {
+    type: BooleanConstructor;
+    default: undefined;
+    };
+    toolbar: {
+    type: PropType<MachReportToolbarOptions>;
+    default: undefined;
+    };
+    emptyState: {
+    type: PropType<boolean | ReportEmptyState>;
+    default: boolean;
+    };
     gapPx: {
     type: NumberConstructor;
     default: undefined;
@@ -1292,6 +1376,7 @@ export declare const MachReportPreview: {
     onWarning?: ((message: string) => any) | undefined;
     "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
     "onTemplate-import"?: ((result: ExcelImportResult_2) => any) | undefined;
+    "onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
     }>, {
     reload: () => Promise<void>;
     print: () => Promise<void>;
@@ -1316,10 +1401,13 @@ export declare const MachReportPreview: {
     showExport: boolean;
     showPrint: boolean;
     showPdfWindow: boolean;
+    showSettings: boolean;
     showParams: boolean;
+    toolbar: MachReportToolbarOptions;
     messages: Partial<MachReportMessages>;
     excelImport: boolean | ExcelImportOptions_2;
     autoLoad: boolean;
+    emptyState: boolean | ReportEmptyState;
     preset: string;
     paramDefs: ReportParamDef[] | undefined;
     fetcher: PlanFetcher | null;
@@ -1356,6 +1444,18 @@ showPdfWindow: {
 type: BooleanConstructor;
 default: undefined;
 };
+showSettings: {
+type: BooleanConstructor;
+default: undefined;
+};
+toolbar: {
+type: PropType<MachReportToolbarOptions>;
+default: undefined;
+};
+emptyState: {
+type: PropType<boolean | ReportEmptyState>;
+default: boolean;
+};
 gapPx: {
 type: NumberConstructor;
 default: undefined;
@@ -1401,6 +1501,7 @@ onLoaded?: ((pageCount: number) => any) | undefined;
 onWarning?: ((message: string) => any) | undefined;
 "onCell-edit"?: ((edit: ReportCellEdit_2) => any) | undefined;
 "onTemplate-import"?: ((result: ExcelImportResult_2) => any) | undefined;
+"onPreferences-change"?: ((preferences: Readonly<ReportPreviewPreferences>) => any) | undefined;
 }>, {
 reload: () => Promise<void>;
 print: () => Promise<void>;
@@ -1424,6 +1525,7 @@ loaded: (pageCount: number) => any;
 warning: (message: string) => any;
 "cell-edit": (edit: ReportCellEdit_2) => any;
 "template-import": (result: ExcelImportResult_2) => any;
+"preferences-change": (preferences: Readonly<ReportPreviewPreferences>) => any;
 }, string, {
 editable: boolean | ReportEditingOptions;
 height: string;
@@ -1434,15 +1536,19 @@ debug: boolean;
 showExport: boolean;
 showPrint: boolean;
 showPdfWindow: boolean;
+showSettings: boolean;
 showParams: boolean;
+toolbar: MachReportToolbarOptions;
 messages: Partial<MachReportMessages>;
 excelImport: boolean | ExcelImportOptions_2;
 autoLoad: boolean;
+emptyState: boolean | ReportEmptyState;
 preset: string;
 paramDefs: ReportParamDef[] | undefined;
 fetcher: PlanFetcher | null;
 }, {}, string, {}, { [K in keyof GlobalComponents]: GlobalComponents[K] }, { [K in keyof GlobalDirectives]: GlobalDirectives[K] }, string, ComponentProvideOptions> & VNodeProps & AllowedComponentProps & ComponentCustomProps & (new () => {
     $slots: {
+        settings?(_: {}): any;
         default?(_: {}): any;
     };
 });
@@ -1494,6 +1600,18 @@ export declare interface MachReportTheme {
     btnActiveBg: string;
 }
 
+export declare interface MachReportToolbarOptions {
+    search?: boolean;
+    thumbnails?: boolean;
+    zoom?: boolean;
+    /** 编辑能力由 editable 授权；此项仅设置初始交互偏好，默认 true（兼容旧行为）。 */
+    editing?: boolean;
+    /** 导入能力由 excelImport 授权；此项仅设置初始交互偏好，默认 true。 */
+    excelImport?: boolean;
+    /** 未传时显示全部已有出口；空数组表示不提供导出工具。 */
+    exportFormats?: ReportExportFormat[];
+}
+
 export declare function normalizeReportIds(reportId: ReportIdInput): string[];
 
 declare function openPdfWindow(): void;
@@ -1712,6 +1830,10 @@ declare interface RenderPlan {
     pages: PlanPage[];
 }
 
+export declare const REPORT_EXPORT_FORMATS: readonly ReportExportFormat[];
+
+export declare const REPORT_PREVIEW_TOOLS: readonly ["search", "thumbnails", "zoom", ...ReportExportFormat[], "print", "pdfWindow", "editing", "import"];
+
 /** 预览中的物理坐标；合并单元格使用左上角坐标。 */
 declare interface ReportCellAddress {
     pageIndex: number;
@@ -1806,6 +1928,15 @@ export declare interface ReportEditOperation {
     signal: AbortSignal;
 }
 
+/** 报表含表头但业务行为空时，由接入方明确声明；组件不推测业务数据。 */
+export declare interface ReportEmptyState {
+    title?: string;
+    description?: string;
+}
+
+/** 输出能力仍由宿主授权；工具偏好只决定当前预览实例的可见与启用状态。 */
+export declare type ReportExportFormat = "html" | "pdf" | "xlsx" | "png" | "word";
+
 /** 保持 Promise<RenderPlan> 契约；元数据为可选，旧业务 fetcher 无需改造。 */
 declare interface ReportFetcher {
     (input: ReportFetchInput): Promise<RenderPlan>;
@@ -1889,6 +2020,10 @@ onQuery?: (() => any) | undefined;
 
 export declare const ReportPreview: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 
+export declare type ReportPreviewPreferences = Record<ReportPreviewTool, boolean>;
+
+export declare type ReportPreviewTool = typeof REPORT_PREVIEW_TOOLS[number];
+
 declare type ReportRegistry = Record<string, ReportDefinition>;
 
 declare interface ReportTemplate {
@@ -1925,6 +2060,7 @@ goto: (page: number) => any;
 "search-toggle": () => any;
 "thumbs-toggle": () => any;
 "import-excel": () => any;
+"settings-toggle": () => any;
 }, string, PublicProps, Readonly<__VLS_Props> & Readonly<{
 onPrint?: (() => any) | undefined;
 onExport?: ((format: "html" | "png" | "pdf" | "xlsx" | "word") => any) | undefined;
@@ -1936,13 +2072,14 @@ onGoto?: ((page: number) => any) | undefined;
 "onSearch-toggle"?: (() => any) | undefined;
 "onThumbs-toggle"?: (() => any) | undefined;
 "onImport-excel"?: (() => any) | undefined;
+"onSettings-toggle"?: (() => any) | undefined;
 }>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {
 searchInputRef: HTMLInputElement;
 }, HTMLDivElement>;
 
 export declare function resolveConfig(config: MachReportConfig | null | undefined, presetName?: string): ResolvedConfig;
 
-export declare type ResolvedConfig = Required<Pick<MachReportDefaults, "showExport" | "showPrint" | "showPdfWindow" | "showParams" | "gapPx">> & {
+export declare type ResolvedConfig = Required<Pick<MachReportDefaults, "showExport" | "showPrint" | "showPdfWindow" | "showSettings" | "showParams" | "gapPx">> & {
     pdfFontUrl: string;
     theme: MachReportTheme;
     messages: MachReportMessages;
@@ -1951,6 +2088,7 @@ export declare type ResolvedConfig = Required<Pick<MachReportDefaults, "showExpo
     xlsx: XlsxRenderOptions;
     editable: boolean | ReportEditingOptions;
     excelImport: boolean | ExcelImportOptions;
+    toolbar: MachReportToolbarOptions;
 };
 
 declare interface RichParagraph {