@agile-team/mach-report 2.0.0 → 2.1.0

package/dist/vue/controller.d.ts

@@ -1,29 +0,0 @@
-/**
- * ReportPreview 的编程式控制器（与组件 ref 方法同面）：
- * reload / print / exportAs / openPdfWindow / gotoPage / setParams。
- */
-export interface MachReportController {
-    reload(): Promise<void>;
-    print(): Promise<void>;
-    /** 支持 html/pdf/xlsx/png/word（excel/image/doc 为兼容别名）；未知格式报 export 错误。 */
-    exportAs(format: string): void;
-    openPdfWindow(): void;
-    gotoPage(page: number): void;
-    /** 编程式设置参数并查询（合并进面板值；opts.reload=false 仅设值不重载） */
-    setParams(values: Record<string, string>, opts?: {
-        reload?: boolean;
-    }): void;
-}
-/**
- * 在 ReportPreview 的任意后代组件中获取控制器（免模板 ref）：
- *
- * ```vue
- * <script setup>
- * import { useReportPreview } from "@agile-team/mach-report/vue";
- * const preview = useReportPreview();
- * </script>
- * <template><button @click="preview?.print()">打印本单</button></template>
- *
- * 不在预览组件内调用时返回 null（不抛错，便于条件渲染场景）。
- */
-export declare function useReportPreview(): MachReportController | null;

package/dist/vue/errors.d.ts

@@ -1,16 +0,0 @@
-/**
- * 结构化错误（code 分类，宿主可按码决定 UX：重试 / 提示 / 降级）。
- * error 事件契约保持 `(message: string)` 不变，新增第二参数 detail（可选）。
- */
-export type MachReportErrorCode = "param" | "fetch" | "validate" | "render" | "pdf" | "print" | "export" | "config";
-export declare class MachReportError extends Error {
-    readonly code: MachReportErrorCode;
-    readonly cause?: unknown;
-    constructor(code: MachReportErrorCode, message: string, cause?: unknown);
-}
-/** error 事件第二参数的形状（向后兼容：仅监听 message 的旧用法不受影响） */
-export interface MachReportErrorDetail {
-    code: MachReportErrorCode;
-    cause?: unknown;
-}
-export declare function toErrorDetail(error: unknown): MachReportErrorDetail;

package/dist/vue/injection-keys.d.ts

@@ -1,14 +0,0 @@
-import { ComputedRef, InjectionKey } from 'vue';
-import { PlanFetcher } from './adapters';
-import { PdfExporter } from './pdf-exporter';
-import { MachReportConfig } from './config';
-import { MachReportController } from './controller';
-/**
- * 注入 key 全部为字符串（而非裸 Symbol）：跨模块联邦边界时宿主与远程
- * 各自打包会生成不同的 Symbol 实例导致 inject 失效；字符串恒等。
- * 保留 InjectionKey 类型以获得类型提示。
- */
-export declare const MACH_REPORT_FETCHER_KEY: InjectionKey<PlanFetcher>;
-export declare const MACH_REPORT_PDF_EXPORTER_KEY: InjectionKey<PdfExporter>;
-export declare const MACH_REPORT_CONFIG_KEY: InjectionKey<ComputedRef<MachReportConfig | null>>;
-export declare const MACH_REPORT_CONTROLLER_KEY: InjectionKey<MachReportController>;

package/dist/vue/local-adapter.d.ts

@@ -1,11 +0,0 @@
-import { ReportTemplate } from '@agile-team/mach-report';
-import { PlanFetcher } from './adapters';
-export interface LocalTemplateEntry {
-    template: ReportTemplate;
-    datasets?: Record<string, Record<string, unknown>[]>;
-}
-/**
- * 本地渲染适配器：模板 + 数据 → core 分页引擎 → RenderPlan。
- * 用于本地预览、离线场景和单测。
- */
-export declare function createLocalFetcher(entries: Record<string, LocalTemplateEntry>): PlanFetcher;

package/dist/vue/pdf-exporter.d.ts

@@ -1,13 +0,0 @@
-import { RenderPlan } from '@agile-team/mach-report';
-/** PDF 导出器：RenderPlan → PDF 字节；第二参数可上报非致命保真告警。 */
-export type PdfExporter = (plan: RenderPlan, onWarning?: (message: string) => void) => Promise<Uint8Array>;
-export interface DefaultPdfExporterOptions {
-    /** 中文字体 URL（浏览器 fetch）；空串跳过字体加载（西文报表） */
-    fontUrl: string;
-}
-/**
- * 默认 PDF 导出器：
- * - 懒加载 @agile-team/mach-report/pdf（含 pdf-lib，只在首次导出时进 bundle）
- * - 字体走 IndexedDB 持久缓存（loadFontWithCache，二次导出零网络）
- */
-export declare function createDefaultPdfExporter(options?: DefaultPdfExporterOptions): PdfExporter;

package/dist/vue/plugin.d.ts

@@ -1,332 +0,0 @@
-import { App } from 'vue';
-import { PlanFetcher } from './adapters';
-import { PdfExporter } from './pdf-exporter';
-import { MachReportConfig } from './config';
-/**
- * 全局组件（懒加载分片：首次渲染才拉取组件与引擎依赖，
- * 与局部 import 等价——首屏敏感页面零额外成本）
- */
-export declare const MachReportPreview: {
-    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
-        reportId: {
-            type: import('vue').PropType<string | string[] | null>;
-            default: null;
-        };
-        params: {
-            type: import('vue').PropType<Record<string, string>>;
-            default: () => {};
-        };
-        height: {
-            type: StringConstructor;
-            default: string;
-        };
-        autoLoad: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        showExport: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        showPrint: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        showPdfWindow: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        gapPx: {
-            type: NumberConstructor;
-            default: undefined;
-        };
-        messages: {
-            type: import('vue').PropType<Partial<import('./config').MachReportMessages>>;
-            default: undefined;
-        };
-        preset: {
-            type: StringConstructor;
-            default: undefined;
-        };
-        debug: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        paramDefs: {
-            type: import('vue').PropType<import('..').ReportParamDef[] | undefined>;
-            default: undefined;
-        };
-        showParams: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        fetcher: {
-            type: import('vue').PropType<PlanFetcher | null>;
-            default: null;
-        };
-    }>> & Readonly<{
-        onError?: ((message: string, detail?: {
-            code: string;
-            cause?: unknown;
-        } | undefined) => any) | undefined;
-        onLoaded?: ((pageCount: number) => any) | undefined;
-        onWarning?: ((message: string) => any) | undefined;
-    }>, {
-        reload: () => Promise<void>;
-        print: () => Promise<void>;
-        exportAs: (format: string) => void;
-        openPdfWindow: () => void;
-        gotoPage: (n: number) => void;
-        setParams: (values: Record<string, string>, opts?: {
-            reload?: boolean;
-        }) => void;
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-        error: (message: string, detail?: {
-            code: string;
-            cause?: unknown;
-        } | undefined) => any;
-        loaded: (pageCount: number) => any;
-        warning: (message: string) => any;
-    }, import('vue').PublicProps, {
-        height: string;
-        gapPx: number;
-        params: Record<string, string>;
-        debug: boolean;
-        showExport: boolean;
-        showPrint: boolean;
-        showPdfWindow: boolean;
-        showParams: boolean;
-        messages: Partial<import('./config').MachReportMessages>;
-        reportId: string | string[] | null;
-        autoLoad: boolean;
-        preset: string;
-        paramDefs: import('..').ReportParamDef[] | undefined;
-        fetcher: PlanFetcher | null;
-    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
-        viewportRef: HTMLDivElement;
-        containerRef: HTMLDivElement;
-        thumbsRef: HTMLElement;
-    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
-        P: {};
-        B: {};
-        D: {};
-        C: {};
-        M: {};
-        Defaults: {};
-    }, Readonly<import('vue').ExtractPropTypes<{
-        reportId: {
-            type: import('vue').PropType<string | string[] | null>;
-            default: null;
-        };
-        params: {
-            type: import('vue').PropType<Record<string, string>>;
-            default: () => {};
-        };
-        height: {
-            type: StringConstructor;
-            default: string;
-        };
-        autoLoad: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        showExport: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        showPrint: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        showPdfWindow: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        gapPx: {
-            type: NumberConstructor;
-            default: undefined;
-        };
-        messages: {
-            type: import('vue').PropType<Partial<import('./config').MachReportMessages>>;
-            default: undefined;
-        };
-        preset: {
-            type: StringConstructor;
-            default: undefined;
-        };
-        debug: {
-            type: BooleanConstructor;
-            default: boolean;
-        };
-        paramDefs: {
-            type: import('vue').PropType<import('..').ReportParamDef[] | undefined>;
-            default: undefined;
-        };
-        showParams: {
-            type: BooleanConstructor;
-            default: undefined;
-        };
-        fetcher: {
-            type: import('vue').PropType<PlanFetcher | null>;
-            default: null;
-        };
-    }>> & Readonly<{
-        onError?: ((message: string, detail?: {
-            code: string;
-            cause?: unknown;
-        } | undefined) => any) | undefined;
-        onLoaded?: ((pageCount: number) => any) | undefined;
-        onWarning?: ((message: string) => any) | undefined;
-    }>, {
-        reload: () => Promise<void>;
-        print: () => Promise<void>;
-        exportAs: (format: string) => void;
-        openPdfWindow: () => void;
-        gotoPage: (n: number) => void;
-        setParams: (values: Record<string, string>, opts?: {
-            reload?: boolean;
-        }) => void;
-    }, {}, {}, {}, {
-        height: string;
-        gapPx: number;
-        params: Record<string, string>;
-        debug: boolean;
-        showExport: boolean;
-        showPrint: boolean;
-        showPdfWindow: boolean;
-        showParams: boolean;
-        messages: Partial<import('./config').MachReportMessages>;
-        reportId: string | string[] | null;
-        autoLoad: boolean;
-        preset: string;
-        paramDefs: import('..').ReportParamDef[] | undefined;
-        fetcher: PlanFetcher | null;
-    }>;
-    __isFragment?: never;
-    __isTeleport?: never;
-    __isSuspense?: never;
-} & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
-    reportId: {
-        type: import('vue').PropType<string | string[] | null>;
-        default: null;
-    };
-    params: {
-        type: import('vue').PropType<Record<string, string>>;
-        default: () => {};
-    };
-    height: {
-        type: StringConstructor;
-        default: string;
-    };
-    autoLoad: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    showExport: {
-        type: BooleanConstructor;
-        default: undefined;
-    };
-    showPrint: {
-        type: BooleanConstructor;
-        default: undefined;
-    };
-    showPdfWindow: {
-        type: BooleanConstructor;
-        default: undefined;
-    };
-    gapPx: {
-        type: NumberConstructor;
-        default: undefined;
-    };
-    messages: {
-        type: import('vue').PropType<Partial<import('./config').MachReportMessages>>;
-        default: undefined;
-    };
-    preset: {
-        type: StringConstructor;
-        default: undefined;
-    };
-    debug: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    paramDefs: {
-        type: import('vue').PropType<import('..').ReportParamDef[] | undefined>;
-        default: undefined;
-    };
-    showParams: {
-        type: BooleanConstructor;
-        default: undefined;
-    };
-    fetcher: {
-        type: import('vue').PropType<PlanFetcher | null>;
-        default: null;
-    };
-}>> & Readonly<{
-    onError?: ((message: string, detail?: {
-        code: string;
-        cause?: unknown;
-    } | undefined) => any) | undefined;
-    onLoaded?: ((pageCount: number) => any) | undefined;
-    onWarning?: ((message: string) => any) | undefined;
-}>, {
-    reload: () => Promise<void>;
-    print: () => Promise<void>;
-    exportAs: (format: string) => void;
-    openPdfWindow: () => void;
-    gotoPage: (n: number) => void;
-    setParams: (values: Record<string, string>, opts?: {
-        reload?: boolean;
-    }) => void;
-}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
-    error: (message: string, detail?: {
-        code: string;
-        cause?: unknown;
-    } | undefined) => any;
-    loaded: (pageCount: number) => any;
-    warning: (message: string) => any;
-}, string, {
-    height: string;
-    gapPx: number;
-    params: Record<string, string>;
-    debug: boolean;
-    showExport: boolean;
-    showPrint: boolean;
-    showPdfWindow: boolean;
-    showParams: boolean;
-    messages: Partial<import('./config').MachReportMessages>;
-    reportId: string | string[] | null;
-    autoLoad: boolean;
-    preset: string;
-    paramDefs: import('..').ReportParamDef[] | undefined;
-    fetcher: PlanFetcher | null;
-}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
-    $slots: {
-        default?(_: {}): any;
-    };
-});
-export interface MachReportPluginOptions {
-    /** 报表数据源；也可直接传给 ReportPreview 的 fetcher prop */
-    fetcher?: PlanFetcher;
-    /** 应用级配置中心（defaults/presets/文案/主题），见 defineMachReportConfig */
-    config?: MachReportConfig;
-    /** PDF 导出字体 URL（默认 /simhei.ttf；'' 跳过字体） */
-    pdfFontUrl?: string;
-    /** 自定义 PDF 导出器（缺省用懒加载引擎 /pdf 子路径的默认实现） */
-    pdfExporter?: PdfExporter;
-    /** 注册全局组件 <MachReportPreview>（默认 true；懒加载分片不影响首屏） */
-    globalComponent?: boolean;
-}
-/**
- * Vue 插件：注册组件、配置和可选的数据源，不绑定任何后端接口。
- *
- * ```ts
- * app.use(machReportPlugin, { fetcher })
- * app.use(machReportPlugin, { config: defineMachReportConfig({...}) })
- * ```
- *
- * 之后业务模板直接写 `<MachReportPreview report-id="X" />`。
- */
-export declare const machReportPlugin: {
-    install(app: App, options?: MachReportPluginOptions): void;
-};

package/dist/xlsx/render-xlsx.d.ts

@@ -1,20 +0,0 @@
-import { default as ExcelJS } from 'exceljs';
-import { RenderPlan } from '../schema/render-plan';
-/**
- * RenderPlan → xlsx 导出（B 端第二出口，对齐家族 @agile-team/mach-table-xlsx 路线）：
- * - 网格组件 → 真表格：列宽（mm→Excel 宽度）、行高（mm→pt）、colSpan/rowSpan 合并、
- *   加粗/对齐/底色/字号直译（resolveGridLayout 复用单真相源几何）
- * - 文本组件 → 合并标题行（顺序流式输出，保字号/加粗/对齐；非像素级定位，
- *   目标是"财务能直接用的对账表"而非复刻版面）
- * - 图片/条码/图表跳过并计入 warnings（与 PDF 保真告警同口径）
- */
-export interface XlsxRenderOptions {
-    /** 工作表命名（默认 "Sheet1" 起序） */
-    sheetName?: (pageIndex: number) => string;
-}
-export interface XlsxRenderResult {
-    workbook: ExcelJS.Workbook;
-    buffer: ExcelJS.Buffer;
-    warnings: string[];
-}
-export declare function renderPlanToXlsx(plan: RenderPlan, options?: XlsxRenderOptions): Promise<XlsxRenderResult>;