@ibiz-template-plugin/ibiz-file-previewer 0.0.24 → 0.0.26

package/dist/types/src/const/type.d.ts

@@ -27,6 +27,8 @@ export declare enum ImageMode {
 export declare enum FileType {
     HTML = "html",
     MD = "md",// Markdown文件
+    YAML = "yaml",// YAML文件
+    YML = "yml",// YML文件
     TXT = "txt",// 文本文件
     JSON = "json",// JSON文件
     XML = "xml",// XML文件

package/dist/types/src/controller/file-preview-item/file-preview-image-controller.d.ts

@@ -4,7 +4,7 @@ import { FilePreviewItemController } from './file-preview-item-controller';
 /**
  * 图片预览控制器
  */
-export declare class FilePreviewImageController<S extends IFilePreviewImageState = IFilePreviewImageState> extends FilePreviewItemController<S> {
+export declare class FilePreviewImageController<S extends IFilePreviewImageState = IFilePreviewImageState, E extends Record<string, any> = Record<string, any>> extends FilePreviewItemController<S, E> {
     protected initState(): void;
     /**
      * 获取内容

package/dist/types/src/controller/file-preview-item/file-preview-image-group-controller.d.ts

@@ -1,9 +1,9 @@
-import { IFilePreviewImageGroupState } from '../../interface';
+import { IFilePreviewImageGroupEvents, IFilePreviewImageGroupState } from '../../interface';
 import { FilePreviewImageController } from './file-preview-image-controller';
 /**
  * 图片组预览
  */
-export declare class FilePreviewImageGroupController<S extends IFilePreviewImageGroupState = IFilePreviewImageGroupState> extends FilePreviewImageController<S> {
+export declare class FilePreviewImageGroupController<S extends IFilePreviewImageGroupState = IFilePreviewImageGroupState, E extends Record<string, any> = IFilePreviewImageGroupEvents> extends FilePreviewImageController<S, E> {
     protected initState(): void;
     /**
      * 获取内容
@@ -13,6 +13,13 @@ export declare class FilePreviewImageGroupController<S extends IFilePreviewImage
      * 切换缩略图面板
      */
     switchThumbnailPanel(): void;
+    /**
+     * 跳转至指定页（0-based）
+     * - 越界或内容未加载时静默忽略
+     * - 同步更新 currentPage，并派发 goToPage 事件由组件执行滚动
+     * @param page 目标页索引
+     */
+    goToPage(page: number): void;
     /**
      * 处理旋转角度改变
      * @param value

package/dist/types/src/controller/file-preview-item/file-preview-item-controller.d.ts

@@ -1,19 +1,28 @@
 import { Signal } from '@preact/signals';
 import { IFilePreviewItemState, IFilePreviewItemController, IFilePreviewShellController } from '../../interface';
+import { EventEmitter } from '../../util';
 /**
  * 文件预览项控制器
  */
-export declare class FilePreviewItemController<S extends IFilePreviewItemState = IFilePreviewItemState> implements IFilePreviewItemController {
+export declare class FilePreviewItemController<S extends IFilePreviewItemState = IFilePreviewItemState, E extends Record<string, any> = Record<string, any>> implements IFilePreviewItemController {
     filePreviewShell: IFilePreviewShellController;
     /**
      * 状态
      */
     state: Signal<S>;
+    /**
+     * 事件对象，用于向组件派发瞬时动作事件
+     */
+    events: EventEmitter<E>;
     /**
      * 构造函数
      * @param filePreviewShell
      */
     constructor(filePreviewShell: IFilePreviewShellController);
+    /**
+     * 工具栏容器唯一 id（代理自 shell controller）
+     */
+    get controlsId(): string;
     /**
      * 更新状态
      * - 所有的状态更新必须调用该方法，以便界面响应

package/dist/types/src/controller/file-preview-shell-controller.d.ts

@@ -18,6 +18,11 @@ export declare class FilePreviewShellController implements IFilePreviewShellCont
      * 文件预览控制器
      */
     preViewController: IFilePreviewItemController | undefined;
+    /**
+     * 当前实例工具栏容器唯一 id（不带 #）
+     * - 构造时确定，生命周期内不变
+     */
+    readonly controlsId: string;
     /**
      * 文件预览器状态对象
      */
@@ -94,4 +99,11 @@ export declare class FilePreviewShellController implements IFilePreviewShellCont
      * @param engineType
      */
     switchEngineType(engineType: EngineType): Promise<void>;
+    /**
+     * 跳转至目标页
+     * - 仅对图片组场景生效，其它场景忽略
+     * - 页码为 0-based
+     * @param page 目标页索引
+     */
+    goToPage(page: number): void;
 }

package/dist/types/src/interface/i-file-preview-item-controller.d.ts

@@ -1,5 +1,6 @@
 import { ComponentType } from 'preact';
 import { FileType, ImageMode } from '../const';
+import { EventEmitter } from '../util';
 import { IFilePreviewShellController } from './i-file-preview-shell-controller';
 /**
  * 文件预览项状态
@@ -84,6 +85,14 @@ export interface IFilePreviewItemController {
      * 状态
      */
     state: Record<string, any>;
+    /**
+     * 当前实例工具栏容器唯一 id（不带 #），由 shell controller 提供
+     */
+    controlsId: string;
+    /**
+     * 事件对象，用于控制器向组件派发瞬时动作事件
+     */
+    events: EventEmitter;
     /**
      * 初始化
      */

package/dist/types/src/interface/i-file-preview-item-events.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 图片组控制器事件
+ */
+export interface IFilePreviewImageGroupEvents {
+    /**
+     * 跳转至目标页（payload 为 0-based 页码）
+     */
+    goToPage: number;
+}

package/dist/types/src/interface/i-file-preview-shell-controller.d.ts

@@ -49,6 +49,11 @@ export interface IFilePreviewShellState {
  * 文件预览壳控制器接口
  */
 export interface IFilePreviewShellController {
+    /**
+     * 当前实例工具栏容器的唯一 DOM id（不带 #）
+     * - 供 shell 渲染容器 id，item 组件 Teleport 时拼接为选择器
+     */
+    controlsId: string;
     /**
      * 更新视图
      * @param data

package/dist/types/src/interface/i-file-previewer-option.d.ts

@@ -123,6 +123,13 @@ export interface IFilePreviewerOption {
      * @param type
      */
     actionSuccessCallBack(type: string): Promise<void>;
+    /**
+     * 预览初始化完成回调
+     * - item 组件挂载完成、预览就绪时触发
+     * - 每次 updateView 或 switchEngineType 后的预览就绪都会触发
+     * - 需要当前预览详情时，在回调内调用 shellController.getState() 获取
+     */
+    onInitialized?: () => void;
 }
 /**
  * 文件预览组件配置项

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

@@ -1,3 +1,4 @@
 export type { IFilePreviewerData, IFilePreviewerOption, } from './i-file-previewer-option';
 export type { IFilePreviewShellState, IFilePreviewShellController, } from './i-file-preview-shell-controller';
 export type { PreviewItemComponent, IFilePreviewItemState, IFilePreviewImageState, IFilePreviewImageGroupState, IFilePreviewItemController, IFilePreviewItemConstructor, } from './i-file-preview-item-controller';
+export type { IFilePreviewImageGroupEvents } from './i-file-preview-item-events';

package/dist/types/src/util/event-emitter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 事件处理函数
+ */
+type EventHandler<T = any> = (payload: T) => void;
+/**
+ * 极简类型安全事件发射器
+ * - on 返回 unsubscribe 函数，便于在 useEffect 中直接 return 清理
+ */
+export declare class EventEmitter<E extends Record<string, any> = Record<string, any>> {
+    private handlers;
+    /**
+     * 订阅事件
+     * @param event 事件名
+     * @param handler 处理函数
+     * @returns 取消订阅函数
+     */
+    on<K extends keyof E>(event: K, handler: EventHandler<E[K]>): () => void;
+    /**
+     * 取消订阅事件
+     * @param event 事件名
+     * @param handler 处理函数
+     */
+    off<K extends keyof E>(event: K, handler: EventHandler<E[K]>): void;
+    /**
+     * 派发事件
+     * @param event 事件名
+     * @param payload 载荷
+     */
+    emit<K extends keyof E>(event: K, payload: E[K]): void;
+}
+export {};

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

@@ -1,2 +1,3 @@
 export { fileNameToFileType, throttle } from './util';
 export { StaticResource } from './static-resource';
+export { EventEmitter } from './event-emitter';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ibiz-template-plugin/ibiz-file-previewer",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "iBiz文件预览器",
   "type": "module",
   "main": "dist/index.es.js",