ice-entity-designer 0.0.22 → 0.0.24

package/dist/types/uml/UmlRelation.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import { ICEPolyLine } from '../ice-render/index';
+/** UML 类图里的六种关系（记法见下方 STYLE_BY_KIND） */
+export declare const UML_RELATION_KINDS: readonly ["inheritance", "realization", "association", "aggregation", "composition", "dependency"];
+export declare type UmlRelationKind = (typeof UML_RELATION_KINDS)[number];
+/** 端点标记种类 */
+export declare type UmlMarker = 'none' | 'triangle' | 'diamond' | 'open';
+declare type UmlRelationStyle = {
+    marker: UmlMarker;
+    /** 标记画在哪一端：整体（owner）一侧 / 目标（被继承、被依赖）一侧 */
+    markerEnd: 'start' | 'end';
+    filled: boolean;
+    dashed: boolean;
+};
+/**
+ * 六种关系的**记法**（UML 2.5 规范）：
+ *
+ * | 关系 | 线型 | 端点 |
+ * |---|---|---|
+ * | 继承 generalization | 实线 | 空心三角，指向父类 |
+ * | 实现 realization | 虚线 | 空心三角，指向接口 |
+ * | 关联 association | 实线 | 无 |
+ * | 聚合 aggregation | 实线 | **空心菱形**，在整体一侧 |
+ * | 组合 composition | 实线 | **实心菱形**，在整体一侧 |
+ * | 依赖 dependency | 虚线 | 开放箭头，指向被依赖方 |
+ */
+export declare const UML_RELATION_STYLE: Record<UmlRelationKind, UmlRelationStyle>;
+/**
+ * @class UmlRelation UML 类图的关系线
+ *
+ * 复用引擎的折线（`ICEPolyLine`）：插槽吸附、正交/贝塞尔路由、标签、跟随宿主都是现成的。
+ * 这里只补 UML 特有的一件事 —— **端点标记**（三角/菱形/开放箭头）。
+ *
+ * 关键实现选择：标记**作为路径点插进 dots**（而不是画上去的装饰），因此
+ * - 描边/填充走引擎既有通道（空心/实心天然可分）；
+ * - SVG 导出**自动带上**标记（导出器读的是同一条命令流）；
+ * - 包围盒、命中检测也跟着正确。
+ */
+export default class UmlRelation extends ICEPolyLine {
+    static readonly typeId = "UmlRelation";
+    constructor(props?: any);
+    protected static arrangeParam(props: any): any;
+    setState(patch: any): void;
+    /** 属性面板/DSL 改关系种类走这里 */
+    applyPatch(patch?: any): void;
+    /** 把记法写进 state：线型、端点、填充、标记种类 */
+    private __applyNotation;
+    /**
+     * @overwrite
+     * 端点标记：按记法把三角/菱形/开放箭头的顶点插进 dots（因此它们是**路径的一部分**）。
+     *
+     * 引擎原生只支持三角（`doCalcArrowPoints()` 返回两个底角），这里对菱形做同样的展开：
+     * 菱形的四个顶点 = 端点 P、两个腰点、远端顶点 —— 闭合后就是一个菱形。
+     */
+    protected calcArrowPoints(): void;
+}
+export {};

package/dist/types/uml/uml_text.d.mts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import type { UmlRelationKind } from './UmlRelation.mjs';
+export declare type UmlTextImportResult = {
+    classes: number;
+    relations: number;
+    /** 解析不了 / 不支持的输入行（不阻断整体导入） */
+    warnings: string[];
+};
+/**
+ * 导出为 PlantUML 文本（`@startuml` 起）。
+ *
+ * 只输出**记法本身**（类、成员、关系），不输出布局坐标 —— PlantUML 自己会排；
+ * 需要保坐标的场景用引擎快照（`serialize()`）或 SVG 导出。
+ */
+export declare function toPlantUml(designer: any, options?: {
+    title?: string;
+}): string;
+/**
+ * 从 PlantUML / Mermaid 类图文本导入（容错：不认识的行进 `warnings`，不阻断整体导入）。
+ *
+ * 会先清空目标 designer 的当前模型（与 BPMN XML 导入同一语义）。
+ */
+export declare function fromPlantUml(text: string, designer: any): UmlTextImportResult;
+/** 关系记法 ↔ PlantUML 连接符（供文档/属性面板展示） */
+export declare function arrowOf(kind: UmlRelationKind): string;
+/** 判断文本看起来是哪种方言（两者都被支持，这里只影响提示文案） */
+export declare function detectUmlDialect(text: string): 'plantuml' | 'mermaid' | 'unknown';

package/dist/types/uml/uml_text.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2022 大漠穷秋.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+import type { UmlRelationKind } from './UmlRelation';
+export declare type UmlTextImportResult = {
+    classes: number;
+    relations: number;
+    /** 解析不了 / 不支持的输入行（不阻断整体导入） */
+    warnings: string[];
+};
+/**
+ * 导出为 PlantUML 文本（`@startuml` 起）。
+ *
+ * 只输出**记法本身**（类、成员、关系），不输出布局坐标 —— PlantUML 自己会排；
+ * 需要保坐标的场景用引擎快照（`serialize()`）或 SVG 导出。
+ */
+export declare function toPlantUml(designer: any, options?: {
+    title?: string;
+}): string;
+/**
+ * 从 PlantUML / Mermaid 类图文本导入（容错：不认识的行进 `warnings`，不阻断整体导入）。
+ *
+ * 会先清空目标 designer 的当前模型（与 BPMN XML 导入同一语义）。
+ */
+export declare function fromPlantUml(text: string, designer: any): UmlTextImportResult;
+/** 关系记法 ↔ PlantUML 连接符（供文档/属性面板展示） */
+export declare function arrowOf(kind: UmlRelationKind): string;
+/** 判断文本看起来是哪种方言（两者都被支持，这里只影响提示文案） */
+export declare function detectUmlDialect(text: string): 'plantuml' | 'mermaid' | 'unknown';

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "大漠穷秋",
   "name": "ice-entity-designer",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "An entity designer based on ice-render.",
   "repository": {
     "type": "git",