@canvas-components/react-print-design 0.0.0-stage → 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,59 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+import { PrintDesignOptions, PrintDesignDocument, PrintDesignSelection, PrintDesign } from '@canvas-components/print-design';
+
+/** React 打印设计器属性。传入 document 时可使用受控文档模式。 */
+interface ReactPrintDesignProps extends Omit<PrintDesignOptions, "onChange" | "onSelectionChange" | "onActivePageChange"> {
+    className?: string;
+    style?: CSSProperties;
+    /** 模板内容变化回调。 */
+    onChange?: (document: PrintDesignDocument) => void;
+    /** 选区变化回调。 */
+    onSelectionChange?: (selection: PrintDesignSelection) => void;
+    /** 活动页面变化回调。 */
+    onActivePageChange?: (pageId: string) => void;
+    /** 是否显示内置工具栏与属性面板。@default true */
+    editor?: boolean;
+    /** 按业务键将模板版本保存到 IndexedDB。 */
+    storeKey?: string;
+    /** 传入数据的结构标识；变更后旧模板版本标记为失效。 */
+    dataFormatKey?: string;
+    /** 不可删除的内置模板；未传入时使用初始 document。 */
+    defaultTemplates?: readonly PrintDesignDocument[];
+    /** 弹窗关闭操作，传入时在工具栏右侧显示关闭按钮。 */
+    onClose?: () => void;
+    /** 外部控制的全屏状态。 */
+    fullscreen?: boolean;
+    /** 外部全屏切换回调；未传入时编辑器使用浏览器全屏。 */
+    onFullscreenChange?: (fullscreen: boolean) => void;
+    /** 是否显示右上角全屏切换按钮。@default true */
+    showFullscreenButton?: boolean;
+}
+/**
+ * 基于 print-design 原生 Canvas 核心的 React 编辑器。
+ */
+declare const ReactPrintDesign: react.ForwardRefExoticComponent<ReactPrintDesignProps & react.RefAttributes<PrintDesign>>;
+
+/** 同一 storeKey 下的一个模板历史版本。 */
+interface PrintDesignTemplateVersion {
+    id: string;
+    templateId: string;
+    version: number;
+    savedAt: number;
+    creator?: string;
+    createdAt?: number;
+    updatedAt?: number;
+    dataFormat?: string;
+    document: PrintDesignDocument;
+}
+/** 读取并验证指定业务键的模板版本。 */
+declare function readPrintDesignTemplates(storeKey: string): Promise<PrintDesignTemplateVersion[]>;
+
+/** 仅比较字段结构与值类型，不记录实际业务数据。 */
+declare function getPrintDesignDataFormat(data?: Record<string, unknown>): string | undefined;
+/** 旧版本没有格式签名时，检查其表格绑定列是否仍可从传入数据读取。 */
+declare function isPrintDesignDocumentCompatible(document: PrintDesignDocument, data?: Record<string, unknown>): boolean;
+/** 当前输入与保存版本的数据格式不一致时判定为失效。 */
+declare function isPrintDesignTemplateInvalid(version: PrintDesignTemplateVersion, dataFormat?: string, data?: Record<string, unknown>): boolean;
+
+export { type PrintDesignTemplateVersion, ReactPrintDesign, type ReactPrintDesignProps, getPrintDesignDataFormat, isPrintDesignDocumentCompatible, isPrintDesignTemplateInvalid, readPrintDesignTemplates };

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+import { PrintDesignOptions, PrintDesignDocument, PrintDesignSelection, PrintDesign } from '@canvas-components/print-design';
+
+/** React 打印设计器属性。传入 document 时可使用受控文档模式。 */
+interface ReactPrintDesignProps extends Omit<PrintDesignOptions, "onChange" | "onSelectionChange" | "onActivePageChange"> {
+    className?: string;
+    style?: CSSProperties;
+    /** 模板内容变化回调。 */
+    onChange?: (document: PrintDesignDocument) => void;
+    /** 选区变化回调。 */
+    onSelectionChange?: (selection: PrintDesignSelection) => void;
+    /** 活动页面变化回调。 */
+    onActivePageChange?: (pageId: string) => void;
+    /** 是否显示内置工具栏与属性面板。@default true */
+    editor?: boolean;
+    /** 按业务键将模板版本保存到 IndexedDB。 */
+    storeKey?: string;
+    /** 传入数据的结构标识；变更后旧模板版本标记为失效。 */
+    dataFormatKey?: string;
+    /** 不可删除的内置模板；未传入时使用初始 document。 */
+    defaultTemplates?: readonly PrintDesignDocument[];
+    /** 弹窗关闭操作，传入时在工具栏右侧显示关闭按钮。 */
+    onClose?: () => void;
+    /** 外部控制的全屏状态。 */
+    fullscreen?: boolean;
+    /** 外部全屏切换回调；未传入时编辑器使用浏览器全屏。 */
+    onFullscreenChange?: (fullscreen: boolean) => void;
+    /** 是否显示右上角全屏切换按钮。@default true */
+    showFullscreenButton?: boolean;
+}
+/**
+ * 基于 print-design 原生 Canvas 核心的 React 编辑器。
+ */
+declare const ReactPrintDesign: react.ForwardRefExoticComponent<ReactPrintDesignProps & react.RefAttributes<PrintDesign>>;
+
+/** 同一 storeKey 下的一个模板历史版本。 */
+interface PrintDesignTemplateVersion {
+    id: string;
+    templateId: string;
+    version: number;
+    savedAt: number;
+    creator?: string;
+    createdAt?: number;
+    updatedAt?: number;
+    dataFormat?: string;
+    document: PrintDesignDocument;
+}
+/** 读取并验证指定业务键的模板版本。 */
+declare function readPrintDesignTemplates(storeKey: string): Promise<PrintDesignTemplateVersion[]>;
+
+/** 仅比较字段结构与值类型，不记录实际业务数据。 */
+declare function getPrintDesignDataFormat(data?: Record<string, unknown>): string | undefined;
+/** 旧版本没有格式签名时，检查其表格绑定列是否仍可从传入数据读取。 */
+declare function isPrintDesignDocumentCompatible(document: PrintDesignDocument, data?: Record<string, unknown>): boolean;
+/** 当前输入与保存版本的数据格式不一致时判定为失效。 */
+declare function isPrintDesignTemplateInvalid(version: PrintDesignTemplateVersion, dataFormat?: string, data?: Record<string, unknown>): boolean;
+
+export { type PrintDesignTemplateVersion, ReactPrintDesign, type ReactPrintDesignProps, getPrintDesignDataFormat, isPrintDesignDocumentCompatible, isPrintDesignTemplateInvalid, readPrintDesignTemplates };