@agile-team/mach-report 0.5.0 → 0.7.0

package/dist/vue/controller.d.ts

@@ -0,0 +1,24 @@
+/**
+ * ReportPreview 的编程式控制器（与组件 ref 方法同面）：
+ * reload / print / exportAs / openPdfWindow / gotoPage。
+ */
+export interface MachReportController {
+    reload(): Promise<void>;
+    print(): Promise<void>;
+    exportAs(format: "html" | "pdf" | string): void;
+    openPdfWindow(): void;
+    gotoPage(page: number): 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

@@ -0,0 +1,16 @@
+/**
+ * 结构化错误（code 分类，宿主可按码决定 UX：重试 / 提示 / 降级）。
+ * error 事件契约保持 `(message: string)` 不变，新增第二参数 detail（可选）。
+ */
+export type MachReportErrorCode = "param" | "fetch" | "validate" | "render" | "pdf" | "print" | "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/index.d.cts

@@ -0,0 +1,13 @@
+export { default as ReportPreview } from './ReportPreview';
+export { default as ReportToolbar } from './ReportToolbar';
+export * from './adapters';
+export * from './local-adapter';
+export * from './injection-keys';
+export * from './plugin';
+export * from './config';
+export * from './pdf-exporter';
+export * from './errors';
+export * from './controller';
+export * from './composables/usePageWindow';
+export * from './composables/useZoom';
+export * from './composables/usePrintExport';

package/dist/vue/index.d.ts

@@ -0,0 +1,13 @@
+export { default as ReportPreview } from './ReportPreview';
+export { default as ReportToolbar } from './ReportToolbar';
+export * from './adapters';
+export * from './local-adapter';
+export * from './injection-keys';
+export * from './plugin';
+export * from './config';
+export * from './pdf-exporter';
+export * from './errors';
+export * from './controller';
+export * from './composables/usePageWindow';
+export * from './composables/useZoom';
+export * from './composables/usePrintExport';

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

@@ -0,0 +1,14 @@
+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

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

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

@@ -0,0 +1,13 @@
+import { RenderPlan } from '@agile-team/mach-report';
+/** PDF 导出器：RenderPlan → PDF 字节。宿主可注入自定义实现（自研后端/Worker 化等）。 */
+export type PdfExporter = (plan: RenderPlan) => 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

@@ -0,0 +1,294 @@
+import { App } from 'vue';
+import { PlanFetcher, HostRequest } 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<{
+        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<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: 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<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: 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<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: 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 {
+    /**
+     * 数据面（全部可选——零配置时用全局 fetch 同源直连）：
+     * - request：宿主 http 客户端（axios 风格签名）
+     * - fetcher：完整 PlanFetcher（自定义数据面/本地模板，优先级最高）
+     */
+    request?: HostRequest;
+    baseUrl?: string;
+    fetcher?: PlanFetcher;
+    /** 应用级配置中心（defaults/presets/文案/主题），见 defineMachReportConfig */
+    config?: MachReportConfig;
+    /** PDF 导出字体 URL（默认 /simhei.ttf；'' 跳过字体） */
+    pdfFontUrl?: string;
+    /** 自定义 PDF 导出器（缺省用懒加载引擎 /pdf 子路径的默认实现） */
+    pdfExporter?: PdfExporter;
+    /** 注册全局组件 <MachReportPreview>（默认 true；懒加载分片不影响首屏） */
+    globalComponent?: boolean;
+}
+/**
+ * Vue 插件（零配置可用，对齐 mach-table 的快速集成体验）：
+ *
+ * ```ts
+ * app.use(machReportPlugin)                              // 同源 jh4j 部署，零胶水
+ * app.use(machReportPlugin, { baseUrl: "/sub/mach-report" })
+ * app.use(machReportPlugin, { request: axios, config: defineMachReportConfig({...}) })
+ * ```
+ *
+ * 之后业务模板直接写 `<MachReportPreview temp-id="X" />`。
+ */
+export declare const machReportPlugin: {
+    install(app: App, options?: MachReportPluginOptions): void;
+};

package/dist/vue-async.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const n=require("vue"),i=require("./plugin-Cl-IqCqx.cjs"),r=n.defineAsyncComponent(()=>Promise.resolve().then(()=>require("./ReportPreview-CrVeTKu1.cjs")).then(e=>e.ReportPreview$1));function c(){return Promise.resolve().then(()=>require("./ReportPreview-CrVeTKu1.cjs")).then(e=>e.ReportPreview$1)}const t={install(e,o={}){i.machReportPlugin.install(e,o),e.component("MachReportPreview",r)}};exports.MachReportPreview=r;exports.default=t;exports.machReportAsyncPlugin=t;exports.preloadMachReport=c;

package/dist/vue-async.js

@@ -0,0 +1,17 @@
+import { defineAsyncComponent as e } from "vue";
+import { m as n } from "./plugin-Dp3kKWiQ.js";
+const r = e(() => import("./ReportPreview-DgsOdO4y.js").then((t) => t.j));
+function m() {
+  return import("./ReportPreview-DgsOdO4y.js").then((t) => t.j);
+}
+const p = {
+  install(t, o = {}) {
+    n.install(t, o), t.component("MachReportPreview", r);
+  }
+};
+export {
+  r as MachReportPreview,
+  p as default,
+  p as machReportAsyncPlugin,
+  m as preloadMachReport
+};

package/dist/vue.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./ReportPreview-CrVeTKu1.cjs"),r=require("./plugin-Cl-IqCqx.cjs"),c=require("@agile-team/mach-report"),s=require("vue");function p(R){return async({tempIds:t})=>{if(t.length===0)throw new r.PlanLoadError("缺少报表模板 ID");const a=[];for(const n of t){const o=R[n];if(!o)throw new r.PlanLoadError(`本地模板 ${n} 不存在`);const{plan:E,warnings:i}=c.paginateTemplate(o.template,o.datasets??{});i.length>0&&console.warn("[mach-report] 分页告警:",i),a.push(...E.pages)}return{schemaVersion:"mach-local",pages:a}}}function P(){return s.inject(r.MACH_REPORT_CONTROLLER_KEY,null)}exports.DEFAULT_MESSAGES=e.DEFAULT_MESSAGES;exports.DEFAULT_THEME=e.DEFAULT_THEME;exports.MachReportError=e.MachReportError;exports.ReportPreview=e.ReportPreview;exports.ReportToolbar=e.ReportToolbar;exports.buildPrintDocument=e.buildPrintDocument;exports.defineMachReportConfig=e.defineMachReportConfig;exports.defineMachReportPreset=e.defineMachReportPreset;exports.provideMachReportConfig=e.provideMachReportConfig;exports.resolveConfig=e.resolveConfig;exports.themeToCssVars=e.themeToCssVars;exports.toErrorDetail=e.toErrorDetail;exports.useMachReportConfig=e.useMachReportConfig;exports.usePageWindow=e.usePageWindow;exports.usePrintExport=e.usePrintExport;exports.useZoom=e.useZoom;exports.MACH_REPORT_CONFIG_KEY=r.MACH_REPORT_CONFIG_KEY;exports.MACH_REPORT_CONTROLLER_KEY=r.MACH_REPORT_CONTROLLER_KEY;exports.MACH_REPORT_FETCHER_KEY=r.MACH_REPORT_FETCHER_KEY;exports.MACH_REPORT_PDF_EXPORTER_KEY=r.MACH_REPORT_PDF_EXPORTER_KEY;exports.MachReportPreview=r.MachReportPreview;exports.PlanLoadError=r.PlanLoadError;exports.createDefaultPdfExporter=r.createDefaultPdfExporter;exports.createFetchRequest=r.createFetchRequest;exports.createJh4jGridPlanFetcher=r.createJh4jGridPlanFetcher;exports.joinTempIds=r.joinTempIds;exports.machReportPlugin=r.machReportPlugin;exports.normalizeTempIds=r.normalizeTempIds;exports.createLocalFetcher=p;exports.useReportPreview=P;

package/dist/vue.js

@@ -0,0 +1,53 @@
+import { D as g, a as T, M as _, R as M, b as d, c as C, d as w, e as D, p as F, r as O, t as A, f as H, u as L, g as v, h as x, i as b } from "./ReportPreview-DgsOdO4y.js";
+import { P as s, M as c } from "./plugin-Dp3kKWiQ.js";
+import { a as K, b as Y, c as G, d as I, e as S, f as y, g as N, j as U, m as V, n as q } from "./plugin-Dp3kKWiQ.js";
+import { paginateTemplate as p } from "@agile-team/mach-report";
+import { inject as R } from "vue";
+function h(n) {
+  return async ({ tempIds: a }) => {
+    if (a.length === 0) throw new s("缺少报表模板 ID");
+    const r = [];
+    for (const o of a) {
+      const e = n[o];
+      if (!e) throw new s(`本地模板 ${o} 不存在`);
+      const { plan: i, warnings: t } = p(e.template, e.datasets ?? {});
+      t.length > 0 && console.warn("[mach-report] 分页告警:", t), r.push(...i.pages);
+    }
+    return { schemaVersion: "mach-local", pages: r };
+  };
+}
+function m() {
+  return R(c, null);
+}
+export {
+  g as DEFAULT_MESSAGES,
+  T as DEFAULT_THEME,
+  K as MACH_REPORT_CONFIG_KEY,
+  c as MACH_REPORT_CONTROLLER_KEY,
+  Y as MACH_REPORT_FETCHER_KEY,
+  G as MACH_REPORT_PDF_EXPORTER_KEY,
+  _ as MachReportError,
+  I as MachReportPreview,
+  s as PlanLoadError,
+  M as ReportPreview,
+  d as ReportToolbar,
+  C as buildPrintDocument,
+  S as createDefaultPdfExporter,
+  y as createFetchRequest,
+  N as createJh4jGridPlanFetcher,
+  h as createLocalFetcher,
+  w as defineMachReportConfig,
+  D as defineMachReportPreset,
+  U as joinTempIds,
+  V as machReportPlugin,
+  q as normalizeTempIds,
+  F as provideMachReportConfig,
+  O as resolveConfig,
+  A as themeToCssVars,
+  H as toErrorDetail,
+  L as useMachReportConfig,
+  v as usePageWindow,
+  x as usePrintExport,
+  m as useReportPreview,
+  b as useZoom
+};

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@agile-team/mach-report",
-  "version": "0.5.0",
-  "description": "MachReport 报表引擎单包：RenderPlan 模型 + 分页 + DOM/Canvas/PDF 渲染 + 动态 SQL + 管理端 API（框架无关、零运行时依赖、子路径按需引入）",
+  "version": "0.7.0",
+  "description": "MachReport 报表引擎单包：RenderPlan 模型 + 分页 + DOM/Canvas/PDF 渲染 + 动态 SQL + 管理端 API + Vue 3 契约组件（零运行时依赖；./vue 为框架子路径，vue 为可选 peer）",
   "type": "module",
-  "sideEffects": false,
+  "sideEffects": [
+    "**/*.css",
+    "**/*.vue"
+  ],
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -46,7 +49,28 @@
         "types": "./dist/manager.d.cts",
         "default": "./dist/manager.cjs"
       }
-    }
+    },
+    "./vue": {
+      "import": {
+        "types": "./dist/vue/index.d.ts",
+        "default": "./dist/vue.js"
+      },
+      "require": {
+        "types": "./dist/vue/index.d.cts",
+        "default": "./dist/vue.cjs"
+      }
+    },
+    "./vue/async": {
+      "import": {
+        "types": "./dist/vue/async.d.ts",
+        "default": "./dist/vue-async.js"
+      },
+      "require": {
+        "types": "./dist/vue/async.d.cts",
+        "default": "./dist/vue-async.cjs"
+      }
+    },
+    "./vue/style.css": "./dist/style.css"
   },
   "publishConfig": {
     "access": "public"
@@ -57,14 +81,28 @@
   "files": [
     "dist"
   ],
+  "peerDependencies": {
+    "vue": "^3.2.0"
+  },
+  "peerDependenciesMeta": {
+    "vue": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@pdf-lib/fontkit": "^1.1.1",
+    "@vitejs/plugin-vue": "^6.0.9",
+    "@vue/test-utils": "^2.4.0",
     "node-sql-parser": "^5.4.0",
     "pdf-lib": "^1.17.1",
-    "tsup": "^8.0.0"
+    "typescript": "^5.9.0",
+    "vite": "^7.3.6",
+    "vite-plugin-dts": "^4.5.0",
+    "vue": "^3.5.0",
+    "vue-tsc": "^3.0.0"
   },
   "scripts": {
-    "build": "tsup && node scripts/copy-dcts.mjs",
+    "build": "vite build && node scripts/copy-dcts.mjs",
     "clean": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\""
   },
   "module": "./dist/index.js"