@borurio-print/print-designer 1.0.5 → 1.0.7

package/dist-lib/PrintDesigner.vue.d.ts

@@ -1,17 +1,19 @@
-import type { BusinessFieldGroup, PrintResult, PrintTemplate } from '@/core/types';
+import type { BusinessFieldGroup, PrintRequest, PrintResult, PrintTemplate, PrintDesignerTheme } from '@/core/types';
 type __VLS_Props = {
     /**
      * 由业务系统提供的可打印字段目录。
      * 设计器只保存字段路径和用户最终选择的展示类型，不感知 WMS、OMS 业务含义。
      */
     fieldGroups?: readonly BusinessFieldGroup[];
+    /** 当前设计器实例使用的主色主题。 */
+    theme?: PrintDesignerTheme;
 };
 declare function getTemplate(): PrintTemplate;
 declare function loadTemplate(template: PrintTemplate): void;
-/** 供业务系统获取 PDF Blob，后续可直接传给本地打印控件。 */
-declare function generatePdf(data: unknown): Promise<Blob>;
-/** 供业务系统直接在浏览器中打开数据打印预览。 */
-declare function previewPdf(data: unknown): Promise<void>;
+/** 供业务系统生成 PDF，结果统一通过 print-result 事件通知。 */
+declare function generatePdf(request: PrintRequest): Promise<void>;
+/** 供业务系统打开 PDF 预览，结果统一通过 print-result 事件通知。 */
+declare function previewPdf(request: PrintRequest): Promise<void>;
 declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {
     getTemplate: typeof getTemplate;
     loadTemplate: typeof loadTemplate;

package/dist-lib/core/theme.d.ts

@@ -0,0 +1,6 @@
+import { type ComputedRef, type CSSProperties, type InjectionKey } from 'vue';
+import type { PrintDesignerTheme } from './types';
+export type PrintDesignerThemeStyle = CSSProperties & Record<`--bpd-${string}`, string>;
+export declare const printDesignerThemeStyleKey: InjectionKey<ComputedRef<PrintDesignerThemeStyle>>;
+export declare function createPrintDesignerThemeStyle(theme?: PrintDesignerTheme): PrintDesignerThemeStyle;
+export declare function usePrintDesignerThemeStyle(): ComputedRef<PrintDesignerThemeStyle>;

package/dist-lib/core/types.d.ts

@@ -36,13 +36,25 @@ export interface PrintRenderPage {
     data?: Record<string, unknown>;
     tableData: Record<string, TableRuntimeData>;
 }
-/** 设计器完成 PDF 预览或内部测试打印后通知业务系统的结果。 */
+/** 业务系统发起一次 PDF 生成或预览的请求。 */
+export interface PrintRequest<T = unknown> {
+    /** 由调用方生成，用于将异步结果与请求一一对应。 */
+    requestId: string;
+    data: T;
+    /** 只有显式需要获取 PDF 文件时才设置为 true。 */
+    returnBlob?: boolean;
+}
+/** 设计器完成 PDF 生成或预览后通过 print-result 通知的结果。 */
 export interface PrintResult {
-    success: boolean;
-    action: 'preview' | 'testPrint';
-    pageCount: number;
-    blob?: Blob;
-    error?: unknown;
+    requestId: string;
+    result: 'success' | 'failed';
+    /** 成功固定为 ok，失败时为可展示的错误信息。 */
+    message: string;
+    data?: {
+        pageCount: number;
+        /** 只在请求中指定 returnBlob: true 时返回。 */
+        blob?: Blob;
+    };
 }
 /** 业务字段目前允许在标签中使用的三种展示方式。 */
 export type FieldElementType = 'text' | 'textBox' | 'qrcode' | 'barcode';
@@ -62,6 +74,17 @@ export interface BusinessFieldGroup {
     label: string;
     fields: readonly BusinessField[];
 }
+/** 业务系统可为每个设计器实例单独配置的主色主题。 */
+export interface PrintDesignerTheme {
+    /** 主色；未传入衍生色时，设计器会自动生成对应的明暗色阶。 */
+    primaryColor?: string;
+    primaryLight3?: string;
+    primaryLight5?: string;
+    primaryLight7?: string;
+    primaryLight8?: string;
+    primaryLight9?: string;
+    primaryDark2?: string;
+}
 /**
  * 设计器支持的组件类型。
  *
@@ -84,6 +107,10 @@ export interface ElementPropertyConfig {
     /** 属性是否适用于元素当前状态，例如固定时间只在“固定”模式下展示。 */
     visibleWhen?: (element: DesignerElement) => boolean;
 }
+/** 元素相对标签画布持续生效的水平对齐规则。 */
+export type CanvasHorizontalAlign = 'left' | 'center' | 'right';
+/** 元素相对标签画布持续生效的垂直对齐规则。 */
+export type CanvasVerticalAlign = 'top' | 'center' | 'bottom';
 /**
  * 所有可编辑元素共用的布局数据。
  * 坐标和尺寸统一使用毫米，rotation 统一使用角度，避免保存屏幕像素后
@@ -98,6 +125,10 @@ export interface BaseDesignerElement {
     heightMm: number;
     rotation: number;
     zIndex: number;
+    /** 缺少时沿用模板保存的 xMm，不做运行时重排。 */
+    canvasHorizontalAlign?: CanvasHorizontalAlign;
+    /** 缺少时沿用模板保存的 yMm，不做运行时重排。 */
+    canvasVerticalAlign?: CanvasVerticalAlign;
 }
 /** 普通文字元素独有的排版属性。 */
 export interface TextDesignerElement extends BaseDesignerElement {