@flyfish-group/file-viewer3 1.0.15 → 1.0.17

package/dist/src/package/common/printCapability.d.ts

@@ -0,0 +1,27 @@
+import { FileRenderExportAdapter } from './type';
+/**
+ * 这些格式只有专属适配器准备好后才展示打印。
+ *
+ * 它们的在线预览常依赖分页引擎、虚拟渲染或 Worker 生命周期，直接克隆
+ * DOM 很容易只得到当前页或当前视口。
+ */
+export declare const ADAPTER_PRINT_REQUIRED_EXTENSIONS: string[];
+/**
+ * 这些格式的预览结果是完整 DOM / SVG / Canvas 截图，解除滚动容器裁切后
+ * 可以稳定进入浏览器打印流程。
+ */
+export declare const DOM_PRINTABLE_EXTENSIONS: string[];
+/**
+ * 这些格式默认不展示打印按钮，避免导出半截内容。
+ *
+ * - 表格链路使用虚拟滚动，只渲染局部窗口；
+ * - 压缩包/邮件包含嵌套预览，顶层不是单一可打印文档；
+ * - EPUB 使用 iframe/连续分页；
+ * - 3D、音视频是交互媒体。
+ */
+export declare const NON_PRINTABLE_EXTENSIONS: string[];
+export declare const normalizeFileExtension: (extension: string) => string;
+export declare const needsDedicatedPrintAdapter: (extension: string) => boolean;
+export declare const isDomPrintableExtension: (extension: string) => boolean;
+export declare const isKnownNonPrintableExtension: (extension: string) => boolean;
+export declare const resolvePrintAvailability: (extension: string, adapter: FileRenderExportAdapter | null, renderedReady: boolean) => boolean;

package/dist/src/package/common/type.d.ts

@@ -48,6 +48,13 @@ export interface FileViewerToolbarOptions {
     download?: boolean;
     print?: boolean;
     exportHtml?: boolean;
+    /**
+     * 内置操作按钮执行前的统一前置钩子。返回 `false` 时会取消本次操作。
+     */
+    beforeOperation?: FileViewerBeforeOperation;
+    beforeDownload?: FileViewerBeforeOperation;
+    beforePrint?: FileViewerBeforeOperation;
+    beforeExportHtml?: FileViewerBeforeOperation;
 }
 /**
  * 压缩包预览配置。
@@ -71,6 +78,45 @@ export interface FileViewerArchiveOptions {
      */
     maxEntryPreviewSize?: number;
 }
+export type FileViewerSourceType = 'file' | 'url' | 'empty';
+export type FileViewerLifecyclePhase = 'load-start' | 'load-complete' | 'unload-start' | 'unload-complete';
+export interface FileViewerLifecycleContext {
+    phase: FileViewerLifecyclePhase;
+    type: string;
+    filename: string;
+    source: FileViewerSourceType;
+    url?: string;
+    file?: File;
+    size?: number;
+    version: number;
+    timestamp: number;
+    duration?: number;
+    reason?: 'replace' | 'reset' | 'component-unmount';
+}
+export interface FileViewerLifecycleHooks {
+    onLoadStart?: (context: FileViewerLifecycleContext) => void | Promise<void>;
+    onLoadComplete?: (context: FileViewerLifecycleContext) => void | Promise<void>;
+    onUnloadStart?: (context: FileViewerLifecycleContext) => void | Promise<void>;
+    onUnloadComplete?: (context: FileViewerLifecycleContext) => void | Promise<void>;
+}
+export type FileViewerOperationType = 'download' | 'print' | 'export-html';
+/**
+ * 当前文档对内置操作的真实可用性。
+ *
+ * `toolbar` 只表达宿主想不想展示某个按钮；这里表达当前文件类型和渲染器
+ * 是否真的能稳定完成该操作。尤其是打印，虚拟表格、播放器、3D 画布、
+ * EPUB iframe 等链路无法保证完整分页输出时会主动关闭。
+ */
+export interface FileViewerOperationAvailability {
+    download: boolean;
+    print: boolean;
+    exportHtml: boolean;
+}
+export interface FileViewerOperationContext extends Omit<FileViewerLifecycleContext, 'phase'> {
+    operation: FileViewerOperationType;
+    label: string;
+}
+export type FileViewerBeforeOperation = (context: FileViewerOperationContext) => boolean | void | Promise<boolean | void>;
 /**
  * 预览器通用配置。
  */
@@ -78,6 +124,15 @@ export interface FileViewerOptions {
     watermark?: boolean | FileViewerWatermarkOptions;
     toolbar?: boolean | FileViewerToolbarOptions;
     archive?: FileViewerArchiveOptions;
+    /**
+     * 文档加载/卸载生命周期钩子。直接使用 Vue 组件时可以传函数；
+     * iframe 集成时同名事件会通过 `postMessage` 向宿主发送。
+     */
+    hooks?: FileViewerLifecycleHooks;
+    /**
+     * 内置操作按钮执行前的全局前置钩子。返回 `false` 时会取消本次操作。
+     */
+    beforeOperation?: FileViewerBeforeOperation;
 }
 /**
  * 导出/打印模式。
@@ -97,6 +152,21 @@ export interface FileRenderExportOptions {
  * 渲染器专属导出适配器。
  */
 export interface FileRenderExportAdapter {
+    /**
+     * 当前渲染器是否允许打印。未设置时由文件类型能力矩阵兜底判断。
+     */
+    print?: boolean;
+    /**
+     * 当前渲染器是否允许导出渲染后的 HTML。
+     */
+    exportHtml?: boolean;
+    /**
+     * 是否把当前页面的全局 style/link 一并带进导出窗口。
+     *
+     * 专属分页适配器通常会自行输出必要样式，应关闭该项，避免宿主应用的
+     * `height: 100vh`、`overflow: hidden` 等布局样式干扰浏览器分页打印。
+     */
+    includeDocumentStyles?: boolean;
     beforeSnapshot?: () => Promise<void> | void;
     toHtml?: (options: FileRenderExportOptions) => Promise<string> | string;
 }

package/dist/src/package/components/FileViewer/FileViewer.vue.d.ts

@@ -1,4 +1,4 @@
-import { FileRef, FileViewerOptions } from '../../common/type';
+import { FileRef, FileViewerLifecycleContext, FileViewerOperationAvailability, FileViewerOptions, FileViewerOperationContext } from '../../common/type';
 type __VLS_Props = {
     /**
      * 本地二进制输入。优先级高于 `url`。
@@ -21,6 +21,31 @@ type __VLS_Props = {
      */
     options?: FileViewerOptions;
 };
-declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: import('vue').DefineComponent<__VLS_Props, {
+    downloadOriginalFile: () => Promise<void>;
+    printRenderedHtml: () => Promise<void>;
+    exportRenderedHtml: () => Promise<void>;
+    getOperationAvailability: () => {
+        download: boolean;
+        print: boolean;
+        exportHtml: boolean;
+    };
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "load-start": (context: FileViewerLifecycleContext) => any;
+    "load-complete": (context: FileViewerLifecycleContext) => any;
+    "unload-start": (context: FileViewerLifecycleContext) => any;
+    "unload-complete": (context: FileViewerLifecycleContext) => any;
+    "operation-before": (context: FileViewerOperationContext) => any;
+    "operation-cancel": (context: FileViewerOperationContext) => any;
+    "operation-availability-change": (availability: FileViewerOperationAvailability) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onLoad-start"?: ((context: FileViewerLifecycleContext) => any) | undefined;
+    "onLoad-complete"?: ((context: FileViewerLifecycleContext) => any) | undefined;
+    "onUnload-start"?: ((context: FileViewerLifecycleContext) => any) | undefined;
+    "onUnload-complete"?: ((context: FileViewerLifecycleContext) => any) | undefined;
+    "onOperation-before"?: ((context: FileViewerOperationContext) => any) | undefined;
+    "onOperation-cancel"?: ((context: FileViewerOperationContext) => any) | undefined;
+    "onOperation-availability-change"?: ((availability: FileViewerOperationAvailability) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 declare const _default: typeof __VLS_export;
 export default _default;

package/dist/src/package/index.d.ts

@@ -19,4 +19,4 @@ declare class Installer implements FileViewerInstaller {
 declare const _default: Installer;
 export default _default;
 export { FileViewer };
-export type { FileRef, FileViewerArchiveOptions, FileViewerOptions, FileViewerToolbarOptions, FileViewerWatermarkOptions } from './common/type';
+export type { FileRef, FileRenderExportAdapter, FileRenderExportMode, FileRenderExportOptions, FileViewerArchiveOptions, FileViewerBeforeOperation, FileViewerLifecycleContext, FileViewerLifecycleHooks, FileViewerLifecyclePhase, FileViewerOperationAvailability, FileViewerOperationContext, FileViewerOperationType, FileViewerOptions, FileViewerSourceType, FileViewerToolbarOptions, FileViewerWatermarkOptions } from './common/type';

package/dist/src/package/vendors/word/doc.d.ts

@@ -1,5 +1,5 @@
-import { AppWrapper } from '../../common/type';
+import { AppWrapper, FileRenderContext } from '../../common/type';
 /**
  * 渲染 doc 文件
  */
-export default function render(buffer: ArrayBuffer, target: HTMLDivElement): Promise<AppWrapper>;
+export default function render(buffer: ArrayBuffer, target: HTMLDivElement, context?: FileRenderContext): Promise<AppWrapper>;

package/dist/src/package/vendors/word/docx.d.ts

@@ -1,5 +1,5 @@
-import { AppWrapper } from '../../common/type';
+import { AppWrapper, FileRenderContext } from '../../common/type';
 /**
  * 渲染docx文件
  */
-export default function (buffer: ArrayBuffer, target: HTMLDivElement): Promise<AppWrapper>;
+export default function (buffer: ArrayBuffer, target: HTMLDivElement, context?: FileRenderContext): Promise<AppWrapper>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyfish-group/file-viewer3",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "private": false,
   "type": "module",
   "packageManager": "pnpm@11.0.9",