@reskin/bpmn 0.0.6 → 0.1.0

package/src/bpmn-viewer/bpmn-viewer.component.d.ts

@@ -1,52 +1,51 @@
-import { AfterContentChecked, EventEmitter, OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
-import type { ImportXMLResult } from 'bpmn-js/lib/BaseViewer';
+/// <reference types="library/bpmn/src/types/diagram-js" />
+import { AfterViewInit, EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
+import type Modeling from 'bpmn-js/lib/features/modeling/Modeling';
+import type ElementRegistry from 'diagram-js/lib/core/ElementRegistry';
 import { Observable } from 'rxjs';
+import { RkBpmnBaseComponent } from '../base/bpmn-base.component';
+import { RkBpmnAfterRenderEvent, RkBpmnImportResult } from '../types/bpmn.types';
 import * as i0 from "@angular/core";
-export declare class RkBpmnViewerComponent implements OnInit, OnChanges, AfterContentChecked, OnDestroy {
+/**
+ * BPMN 流程图查看器组件
+ * 提供只读的 BPMN 2.0 流程图查看功能
+ */
+export declare class RkBpmnViewerComponent extends RkBpmnBaseComponent implements OnChanges, AfterViewInit {
     /**
-     * 值 xml string
+     * BPMN XML 数据
      */
     data: string;
     /**
-     * 监听渲染完成
+     * 渲染完成事件
      */
-    afterRenderChange: EventEmitter<any>;
-    constructor();
-    private el?;
-    private Viewer;
-    private scale;
-    ngOnInit(): void;
+    afterRenderChange: EventEmitter<RkBpmnAfterRenderEvent>;
     ngOnChanges(changes: SimpleChanges): void;
-    ngAfterContentChecked(): void;
-    ngOnDestroy(): void;
+    ngAfterViewInit(): void;
     /**
-     * 初始化bpmnJS app
+     * 初始化 BPMN 查看器
      */
-    private onInitBpmn;
+    private initViewer;
     /**
-     * 注册事件
+     * 注册事件监听
      */
     private registerEvents;
     /**
-     * 设置默认值
+     * 导入 BPMN XML
+     * @param xml BPMN XML 字符串
      */
-    private setDefaultData;
+    importXML(xml: string): Observable<RkBpmnImportResult>;
     /**
      * 重置画板
      */
-    resetDrawingBoard(): Observable<ImportXMLResult>;
+    reset(): Observable<RkBpmnImportResult>;
     /**
-     * 放大
+     * 获取元素注册表
      */
-    zoomIn(): void;
+    getElementRegistry(): ElementRegistry | undefined;
     /**
-     * 缩小
+     * 获取建模对象
      */
-    zoomOut(): void;
-    /**
-     * 重置位置
-     */
-    zoomReset(): void;
+    getModeling(): Modeling | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<RkBpmnViewerComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<RkBpmnViewerComponent, "rk-bpmn-viewer", never, { "data": "data"; }, { "afterRenderChange": "afterRenderChange"; }, never, never>;
 }

package/src/config/defaultXML.d.ts

@@ -1,8 +1,10 @@
 /**
- * 默认值
+ * 生成默认 BPMN XML 数据
+ * @returns 默认的 BPMN XML 字符串
  */
-export declare const defaultBpmnData: string;
+export declare function getDefaultBpmnXML(): string;
 /**
- * 生成随机字符串
+ * 默认 BPMN XML 数据（向后兼容）
+ * @deprecated 请使用 getDefaultBpmnXML() 函数
  */
-export declare function uid(): string;
+export declare const defaultBpmnData: string;

package/src/types/bpmn.types.d.ts

@@ -0,0 +1,58 @@
+import type { ImportXMLResult, SaveSVGResult, SaveXMLResult } from 'bpmn-js/lib/BaseViewer';
+import type BaseViewer from 'bpmn-js/lib/BaseViewer';
+import type Modeling from 'bpmn-js/lib/features/modeling/Modeling';
+import type { Element } from 'bpmn-js/lib/model/Types';
+/**
+ * BPMN 编辑器选中事件数据
+ */
+export interface RkBpmnSelectionChangeEvent {
+    /** BPMN 建模器实例 */
+    modeler: BaseViewer;
+    /** 建模操作对象 */
+    modeling: Modeling;
+    /** 选中的元素 */
+    element: Element;
+}
+/**
+ * BPMN 查看器渲染完成事件数据
+ */
+export interface RkBpmnAfterRenderEvent {
+    /** 所有节点 */
+    nodes: Element[];
+    /** 建模操作对象 */
+    modeling: Modeling;
+    /** 查看器实例 */
+    viewer: BaseViewer;
+}
+/**
+ * BPMN 缩放配置
+ */
+export interface RkBpmnZoomConfig {
+    /** 缩放比例 */
+    scale?: number;
+    /** 最小缩放比例 */
+    minScale?: number;
+    /** 最大缩放比例 */
+    maxScale?: number;
+}
+/**
+ * BPMN 导出配置
+ */
+export interface RkBpmnExportConfig {
+    /** 是否格式化 XML */
+    format?: boolean;
+    /** 文件名（不含扩展名） */
+    filename?: string;
+}
+/**
+ * BPMN 导入结果
+ */
+export declare type RkBpmnImportResult = ImportXMLResult;
+/**
+ * BPMN 保存 XML 结果
+ */
+export declare type RkBpmnSaveXMLResult = SaveXMLResult;
+/**
+ * BPMN 保存 SVG 结果
+ */
+export declare type RkBpmnSaveSVGResult = SaveSVGResult;

package/src/utils/bpmn.utils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 生成唯一 ID
+ * @returns 随机字符串
+ */
+export declare function generateUid(): string;
+/**
+ * 下载文件
+ * @param content 文件内容或 Blob URL
+ * @param filename 文件名
+ */
+export declare function downloadFile(content: string | Blob, filename: string): void;
+/**
+ * 读取文件内容
+ * @param file 文件对象
+ * @returns Promise<string>
+ */
+export declare function readFileAsText(file: File): Promise<string>;