@agile-team/mach-report 0.5.0 → 0.7.0

package/dist/vue/async.d.cts

@@ -0,0 +1,275 @@
+import { MachReportPluginOptions } from './plugin';
+/**
+ * 异步插件入口（@agile-team/mach-report/vue/async）：
+ *
+ * 首屏敏感页面用异步全局组件代替静态 import——组件与其引擎依赖
+ * 拆为独立 chunk，路由级按需加载：
+ *
+ * ```ts
+ * import AsyncMachReportPlugin, { preloadMachReport } from "@agile-team/mach-report/vue/async";
+ * app.use(AsyncMachReportPlugin, { baseUrl: "/sub/mach-report" });
+ * void preloadMachReport(); // 可选：路由 hover 时预取
+ * // 模板：<MachReportPreview temp-id="X" />
+ * ```
+ */
+/** 全局异步组件（懒加载 ReportPreview 及其引擎分片；与主插件同源共享） */
+export declare const MachReportPreview: {
+    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+        tempId: {
+            type: import('vue').PropType<string | string[] | null>;
+            default: null;
+        };
+        furnitureTempId: {
+            type: StringConstructor;
+            default: string;
+        };
+        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;
+        };
+        fetcher: {
+            type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+            default: null;
+        };
+    }>> & Readonly<{
+        onError?: ((message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any) | undefined;
+        onLoaded?: ((pageCount: number) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        print: () => Promise<void>;
+        exportAs: (format: string) => void;
+        openPdfWindow: () => void;
+        gotoPage: (n: number) => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+        error: (message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any;
+        loaded: (pageCount: number) => any;
+    }, import('vue').PublicProps, {
+        height: string;
+        gapPx: number;
+        params: Record<string, string>;
+        furnitureTempId: string;
+        tempId: string | string[] | null;
+        showExport: boolean;
+        showPrint: boolean;
+        showPdfWindow: boolean;
+        messages: Partial<import('./config').MachReportMessages>;
+        autoLoad: boolean;
+        preset: string;
+        fetcher: import('./adapters').PlanFetcher | null;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+        viewportRef: HTMLDivElement;
+        containerRef: HTMLDivElement;
+    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('vue').ExtractPropTypes<{
+        tempId: {
+            type: import('vue').PropType<string | string[] | null>;
+            default: null;
+        };
+        furnitureTempId: {
+            type: StringConstructor;
+            default: string;
+        };
+        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;
+        };
+        fetcher: {
+            type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+            default: null;
+        };
+    }>> & Readonly<{
+        onError?: ((message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any) | undefined;
+        onLoaded?: ((pageCount: number) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        print: () => Promise<void>;
+        exportAs: (format: string) => void;
+        openPdfWindow: () => void;
+        gotoPage: (n: number) => void;
+    }, {}, {}, {}, {
+        height: string;
+        gapPx: number;
+        params: Record<string, string>;
+        furnitureTempId: string;
+        tempId: string | string[] | null;
+        showExport: boolean;
+        showPrint: boolean;
+        showPdfWindow: boolean;
+        messages: Partial<import('./config').MachReportMessages>;
+        autoLoad: boolean;
+        preset: string;
+        fetcher: import('./adapters').PlanFetcher | null;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+    tempId: {
+        type: import('vue').PropType<string | string[] | null>;
+        default: null;
+    };
+    furnitureTempId: {
+        type: StringConstructor;
+        default: string;
+    };
+    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;
+    };
+    fetcher: {
+        type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+        default: null;
+    };
+}>> & Readonly<{
+    onError?: ((message: string, detail?: {
+        code: string;
+        cause?: unknown;
+    } | undefined) => any) | undefined;
+    onLoaded?: ((pageCount: number) => any) | undefined;
+}>, {
+    reload: () => Promise<void>;
+    print: () => Promise<void>;
+    exportAs: (format: string) => void;
+    openPdfWindow: () => void;
+    gotoPage: (n: number) => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    error: (message: string, detail?: {
+        code: string;
+        cause?: unknown;
+    } | undefined) => any;
+    loaded: (pageCount: number) => any;
+}, string, {
+    height: string;
+    gapPx: number;
+    params: Record<string, string>;
+    furnitureTempId: string;
+    tempId: string | string[] | null;
+    showExport: boolean;
+    showPrint: boolean;
+    showPdfWindow: boolean;
+    messages: Partial<import('./config').MachReportMessages>;
+    autoLoad: boolean;
+    preset: string;
+    fetcher: import('./adapters').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;
+    };
+});
+/** 预取组件分片（路由 hover / 空闲时调用，正式渲染零等待） */
+export declare function preloadMachReport(): Promise<unknown>;
+export declare const machReportAsyncPlugin: {
+    install(app: import('vue').App, options?: MachReportPluginOptions): void;
+};
+export default machReportAsyncPlugin;

package/dist/vue/async.d.ts

@@ -0,0 +1,275 @@
+import { MachReportPluginOptions } from './plugin';
+/**
+ * 异步插件入口（@agile-team/mach-report/vue/async）：
+ *
+ * 首屏敏感页面用异步全局组件代替静态 import——组件与其引擎依赖
+ * 拆为独立 chunk，路由级按需加载：
+ *
+ * ```ts
+ * import AsyncMachReportPlugin, { preloadMachReport } from "@agile-team/mach-report/vue/async";
+ * app.use(AsyncMachReportPlugin, { baseUrl: "/sub/mach-report" });
+ * void preloadMachReport(); // 可选：路由 hover 时预取
+ * // 模板：<MachReportPreview temp-id="X" />
+ * ```
+ */
+/** 全局异步组件（懒加载 ReportPreview 及其引擎分片；与主插件同源共享） */
+export declare const MachReportPreview: {
+    new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('vue').ExtractPropTypes<{
+        tempId: {
+            type: import('vue').PropType<string | string[] | null>;
+            default: null;
+        };
+        furnitureTempId: {
+            type: StringConstructor;
+            default: string;
+        };
+        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;
+        };
+        fetcher: {
+            type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+            default: null;
+        };
+    }>> & Readonly<{
+        onError?: ((message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any) | undefined;
+        onLoaded?: ((pageCount: number) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        print: () => Promise<void>;
+        exportAs: (format: string) => void;
+        openPdfWindow: () => void;
+        gotoPage: (n: number) => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+        error: (message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any;
+        loaded: (pageCount: number) => any;
+    }, import('vue').PublicProps, {
+        height: string;
+        gapPx: number;
+        params: Record<string, string>;
+        furnitureTempId: string;
+        tempId: string | string[] | null;
+        showExport: boolean;
+        showPrint: boolean;
+        showPdfWindow: boolean;
+        messages: Partial<import('./config').MachReportMessages>;
+        autoLoad: boolean;
+        preset: string;
+        fetcher: import('./adapters').PlanFetcher | null;
+    }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
+        viewportRef: HTMLDivElement;
+        containerRef: HTMLDivElement;
+    }, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('vue').ExtractPropTypes<{
+        tempId: {
+            type: import('vue').PropType<string | string[] | null>;
+            default: null;
+        };
+        furnitureTempId: {
+            type: StringConstructor;
+            default: string;
+        };
+        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;
+        };
+        fetcher: {
+            type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+            default: null;
+        };
+    }>> & Readonly<{
+        onError?: ((message: string, detail?: {
+            code: string;
+            cause?: unknown;
+        } | undefined) => any) | undefined;
+        onLoaded?: ((pageCount: number) => any) | undefined;
+    }>, {
+        reload: () => Promise<void>;
+        print: () => Promise<void>;
+        exportAs: (format: string) => void;
+        openPdfWindow: () => void;
+        gotoPage: (n: number) => void;
+    }, {}, {}, {}, {
+        height: string;
+        gapPx: number;
+        params: Record<string, string>;
+        furnitureTempId: string;
+        tempId: string | string[] | null;
+        showExport: boolean;
+        showPrint: boolean;
+        showPdfWindow: boolean;
+        messages: Partial<import('./config').MachReportMessages>;
+        autoLoad: boolean;
+        preset: string;
+        fetcher: import('./adapters').PlanFetcher | null;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import('vue').ComponentOptionsBase<Readonly<import('vue').ExtractPropTypes<{
+    tempId: {
+        type: import('vue').PropType<string | string[] | null>;
+        default: null;
+    };
+    furnitureTempId: {
+        type: StringConstructor;
+        default: string;
+    };
+    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;
+    };
+    fetcher: {
+        type: import('vue').PropType<import('./adapters').PlanFetcher | null>;
+        default: null;
+    };
+}>> & Readonly<{
+    onError?: ((message: string, detail?: {
+        code: string;
+        cause?: unknown;
+    } | undefined) => any) | undefined;
+    onLoaded?: ((pageCount: number) => any) | undefined;
+}>, {
+    reload: () => Promise<void>;
+    print: () => Promise<void>;
+    exportAs: (format: string) => void;
+    openPdfWindow: () => void;
+    gotoPage: (n: number) => void;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    error: (message: string, detail?: {
+        code: string;
+        cause?: unknown;
+    } | undefined) => any;
+    loaded: (pageCount: number) => any;
+}, string, {
+    height: string;
+    gapPx: number;
+    params: Record<string, string>;
+    furnitureTempId: string;
+    tempId: string | string[] | null;
+    showExport: boolean;
+    showPrint: boolean;
+    showPdfWindow: boolean;
+    messages: Partial<import('./config').MachReportMessages>;
+    autoLoad: boolean;
+    preset: string;
+    fetcher: import('./adapters').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;
+    };
+});
+/** 预取组件分片（路由 hover / 空闲时调用，正式渲染零等待） */
+export declare function preloadMachReport(): Promise<unknown>;
+export declare const machReportAsyncPlugin: {
+    install(app: import('vue').App, options?: MachReportPluginOptions): void;
+};
+export default machReportAsyncPlugin;

package/dist/vue/composables/usePageWindow.d.ts

@@ -0,0 +1,28 @@
+import { Ref } from 'vue';
+import { PlanPage, RenderPlan } from '@agile-team/mach-report';
+/**
+ * 页级视口虚拟化（DOM 后端）。
+ *
+ * 坐标口径（与 transform: scale 缩放配合）：
+ * - 页高/间距/占位均在"自然坐标系"（未缩放 px）维护
+ * - 视口滚动量与视口高换算回自然系（除以 zoom）后再进 computePageWindow
+ */
+export declare function usePageWindow(plan: Ref<RenderPlan | null>, zoom: Ref<number>, options?: {
+    pxPerMm?: number;
+    gapPx?: number;
+}): {
+    pageHeightsPx: import('vue').ComputedRef<number[]>;
+    contentSize: import('vue').ComputedRef<{
+        w: number;
+        h: number;
+    }>;
+    windowRange: import('vue').ComputedRef<import('@agile-team/mach-report').PageWindow>;
+    visiblePages: import('vue').ComputedRef<{
+        page: PlanPage;
+        index: number;
+    }[]>;
+    scrollTop: Ref<number, number>;
+    viewportHeight: Ref<number, number>;
+    makeScrollHandler: (currentPage: Ref<number>, pageCount: Ref<number>) => (vp: HTMLElement) => void;
+    refreshViewport(vp: HTMLElement | null): void;
+};

package/dist/vue/composables/usePrintExport.d.ts

@@ -0,0 +1,19 @@
+import { Ref } from 'vue';
+import { RenderPlan } from '@agile-team/mach-report';
+import { PdfExporter } from '../pdf-exporter';
+interface PrintHtmlResult {
+    head: string;
+    pageChunks: string[];
+}
+/** 构建打印文档：head（含按尺寸分组的 @page 规则）+ 每页一段 HTML（供流式写入） */
+export declare function buildPrintDocument(p: RenderPlan): PrintHtmlResult;
+export declare function usePrintExport(plan: Ref<RenderPlan | null>, hooks: {
+    getPdfExporter: () => PdfExporter;
+    onError: (message: string) => void;
+}): {
+    print: () => Promise<void>;
+    exportAs: (format: string) => void;
+    openPdfWindow: () => void;
+    releasePrintFrame: () => void;
+};
+export {};

package/dist/vue/composables/useZoom.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 缩放状态（transform: scale 方案）：
+ * - fit 模式：按视口宽自适应（clamp 0.3~1）
+ * - raw 模式：固定百分比
+ * transform 而非 CSS zoom：标准属性、跨浏览器、零重排。
+ */
+export declare function useZoom(getFitInputs: () => {
+    viewport: HTMLElement | null;
+    pageWidthPx: number;
+} | null): {
+    zoom: import('vue').Ref<number, number>;
+    zoomMode: import('vue').Ref<"fit" | "raw", "fit" | "raw">;
+    applyFitZoom: () => void;
+    setZoom: (mode: "fit" | number) => void;
+};

package/dist/vue/config.d.ts

@@ -0,0 +1,79 @@
+import { ComputedRef, CSSProperties } from 'vue';
+/**
+ * 配置中心（对齐 mach-table 的 defineMachTableConfig 体验）：
+ * - 应用级：app.use(machReportPlugin, { config: defineMachReportConfig({...}) })
+ * - 路由级叠加：provideMachReportConfig(overlay)（响应式，就近覆盖）
+ * - 优先级：组件 props > 路由级叠加 > preset > defaults（props 永远最高）
+ */
+/** 工具栏与状态文案（默认简体中文；出海场景覆写） */
+export interface MachReportMessages {
+    title: string;
+    prevPage: string;
+    nextPage: string;
+    /** 页码显示模板，{cur}/{total} 占位 */
+    pageInfo: string;
+    fitWidth: string;
+    exportHtml: string;
+    exportPdf: string;
+    print: string;
+    pdfWindow: string;
+    loading: string;
+    empty: string;
+    errorPrefix: string;
+    retry: string;
+}
+export declare const DEFAULT_MESSAGES: MachReportMessages;
+/** 主题变量（组件外壳注入的 --mrp-* CSS 自定义属性） */
+export interface MachReportTheme {
+    shellBg: string;
+    shellFg: string;
+    toolbarBg: string;
+    toolbarBorder: string;
+    toolbarFg: string;
+    btnFg: string;
+    btnBorder: string;
+    btnHoverBg: string;
+    btnHoverFg: string;
+    btnActiveBg: string;
+}
+export declare const DEFAULT_THEME: MachReportTheme;
+/** defaults 层可配置项（全部可选，均有内置缺省） */
+export interface MachReportDefaults {
+    showExport?: boolean;
+    showPrint?: boolean;
+    showPdfWindow?: boolean;
+    /** 页间距 px */
+    gapPx?: number;
+    /** PDF 导出中文字体 URL */
+    pdfFontUrl?: string;
+    theme?: Partial<MachReportTheme>;
+    messages?: Partial<MachReportMessages>;
+}
+export type MachReportPreset = MachReportDefaults;
+export interface MachReportConfig {
+    defaults: MachReportDefaults;
+    presets: Record<string, MachReportPreset>;
+    /** 默认启用的 preset 名 */
+    defaultPreset?: string;
+}
+/** 类型化配置声明（纯类型助手，便于独立 config 文件） */
+export declare function defineMachReportConfig(config: MachReportConfig): MachReportConfig;
+/** 类型化 preset 声明 */
+export declare function defineMachReportPreset(preset: MachReportPreset): MachReportPreset;
+export type ResolvedConfig = Required<Pick<MachReportDefaults, "showExport" | "showPrint" | "showPdfWindow" | "gapPx">> & {
+    pdfFontUrl: string;
+    theme: MachReportTheme;
+    messages: MachReportMessages;
+};
+export declare function resolveConfig(config: MachReportConfig | null | undefined, presetName?: string): ResolvedConfig;
+/** theme 对象 → CSS 自定义属性 style 对象（注入组件外壳） */
+export declare function themeToCssVars(theme: Partial<MachReportTheme>): CSSProperties;
+type ConfigRef = ComputedRef<MachReportConfig | null>;
+/**
+ * 路由/布局级响应式叠加：就近提供配置层（如某路由关闭导出按钮）。
+ * 与应用级 config 合并（本层 defaults/presets 优先）。
+ */
+export declare function provideMachReportConfig(overlay: MachReportConfig | MachReportDefaults): void;
+/** 组件内部读取当前生效配置层（未提供时返回 null → 走内置缺省） */
+export declare function useMachReportConfig(): ConfigRef;
+export {};