@flowgram.ai/document 0.2.15 → 0.2.17

package/dist/index.d.mts

@@ -57,6 +57,11 @@ declare namespace FlowVirtualTree {
     }
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Render Tree 会只读模式，不具备操作 tree 结构元素
  */
@@ -106,6 +111,11 @@ declare class FlowRenderTree<T extends FlowNodeEntity> extends FlowVirtualTree<T
     removeParent(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentOptions: unique symbol;
 /**
  * 流程画布配置
@@ -163,6 +173,7 @@ declare const ConstantKeys: {
      */
     INLINE_BLOCKS_PADDING_TOP: string;
     NODE_SPACING: string;
+    BRANCH_SPACING: string;
     ROUNDED_LINE_X_RADIUS: string;
     ROUNDED_LINE_Y_RADIUS: string;
     INLINE_BLOCKS_PADDING_BOTTOM: string;
@@ -170,6 +181,11 @@ declare const ConstantKeys: {
     HOVER_AREA_WIDTH: string;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentContribution: unique symbol;
 interface FlowDocumentContribution<T extends FlowDocument = FlowDocument> {
     /**
@@ -184,6 +200,10 @@ interface FlowDocumentContribution<T extends FlowDocument = FlowDocument> {
     loadDocument?(document: T): Promise<void>;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare const FlowDocumentConfigDefaultData: unique symbol;
 /**
  * 用于文档扩展配置
@@ -401,6 +421,7 @@ declare class FlowDocument<T = FlowDocumentJSON> implements Disposable {
      * 返回需要渲染的数据
      */
     getRenderDatas<T extends EntityData>(dataRegistry: EntityDataRegistry<T>, containHiddenNodes?: boolean): T[];
+    toNodeJSON(node: FlowNodeEntity): FlowNodeJSON;
     /**
      * 移动节点
      * @param param0
@@ -591,6 +612,11 @@ declare class FlowNodeTransitionData extends EntityData<FlowNodeTransitionSchema
     get isNodeEnd(): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FlowNodeEntityConfig extends EntityOpts {
     document: FlowDocument;
     flowNodeType: FlowNodeType;
@@ -784,6 +810,11 @@ declare class FlowDocumentTransformerEntity extends ConfigEntity<{
     refresh(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FlowRendererStateEntityConfig extends EntityOpts {
 }
 interface FlowRendererState {
@@ -814,6 +845,11 @@ declare class FlowRendererStateEntity extends ConfigEntity<FlowRendererState, Fl
     onNodeHoveredChange(fn: (hoveredNode: FlowNodeEntity | undefined) => void, debounceTime?: number): Disposable;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FlowTransitionLineEnum {
     STRAIGHT_LINE = 0,
     DIVERGE_LINE = 1,
@@ -884,6 +920,11 @@ interface DragNodeProps {
     node: FlowNodeEntity;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FlowLayoutDefault {
     VERTICAL_FIXED_LAYOUT = "vertical-fixed-layout",
     HORIZONTAL_FIXED_LAYOUT = "horizontal-fixed-layout"
@@ -936,6 +977,11 @@ interface FlowLayout {
     getDefaultNodeOrigin(): IPoint;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * 节点渲染相关配置信息，可扩展
  */
@@ -975,6 +1021,10 @@ declare const DefaultSpacingKey: {
      * 普通节点间距。垂直 / 水平
      */
     NODE_SPACING: string;
+    /**
+     * 分支节点间距
+     */
+    BRANCH_SPACING: string;
     /**
      * 圆弧线条 x radius
      */
@@ -1003,6 +1053,9 @@ declare const DefaultSpacingKey: {
 declare const DEFAULT_SPACING: {
     [x: string]: number;
     NULL: number;
+    /**
+     * @deprecated use 'BRANCH_SPACING' instead
+     */
     MARGIN_RIGHT: number;
     INLINE_BLOCK_PADDING_BOTTOM: number;
     INLINE_BLOCKS_PADDING_TOP: number;
@@ -1153,6 +1206,11 @@ declare namespace FlowNodeRegistry {
     function extend(registry: FlowNodeRegistry, extendRegistries: FlowNodeRegistry[]): FlowNodeRegistry;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FlowNodeType = string | number;
 /**
  * Flow node json data
@@ -1202,6 +1260,11 @@ type AddNodeData = FlowNodeJSON & {
     index?: number;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum OperationType {
     addFromNode = "addFromNode",
     deleteFromNode = "deleteFromNode",
@@ -1448,10 +1511,19 @@ interface FlowOperationBaseService extends Disposable {
 }
 declare const FlowOperationBaseService: unique symbol;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface FlowGroupJSON {
     nodeIDs: string[];
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentContainerModule: ContainerModule;
 
 /**
@@ -1543,6 +1615,11 @@ declare class FlowOperationBaseServiceImpl implements FlowOperationBaseService {
     protected doMoveNode(node: FlowNodeEntity, newParent: FlowNodeEntity, index: number): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /** 分组控制器 */
 declare class FlowGroupController {
     readonly groupNode: FlowNodeEntity;
@@ -1568,6 +1645,11 @@ declare class FlowGroupController {
     static create(groupNode?: FlowNodeEntity): FlowGroupController | undefined;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class FlowGroupService {
     readonly entityManager: EntityManager;
     readonly operationService: FlowOperationBaseService;
@@ -1584,6 +1666,11 @@ declare class FlowGroupService {
     static validate(nodes: FlowNodeEntity[]): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  *
  * @param node 节点 entity

package/dist/index.d.ts

@@ -57,6 +57,11 @@ declare namespace FlowVirtualTree {
     }
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Render Tree 会只读模式，不具备操作 tree 结构元素
  */
@@ -106,6 +111,11 @@ declare class FlowRenderTree<T extends FlowNodeEntity> extends FlowVirtualTree<T
     removeParent(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentOptions: unique symbol;
 /**
  * 流程画布配置
@@ -163,6 +173,7 @@ declare const ConstantKeys: {
      */
     INLINE_BLOCKS_PADDING_TOP: string;
     NODE_SPACING: string;
+    BRANCH_SPACING: string;
     ROUNDED_LINE_X_RADIUS: string;
     ROUNDED_LINE_Y_RADIUS: string;
     INLINE_BLOCKS_PADDING_BOTTOM: string;
@@ -170,6 +181,11 @@ declare const ConstantKeys: {
     HOVER_AREA_WIDTH: string;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentContribution: unique symbol;
 interface FlowDocumentContribution<T extends FlowDocument = FlowDocument> {
     /**
@@ -184,6 +200,10 @@ interface FlowDocumentContribution<T extends FlowDocument = FlowDocument> {
     loadDocument?(document: T): Promise<void>;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare const FlowDocumentConfigDefaultData: unique symbol;
 /**
  * 用于文档扩展配置
@@ -401,6 +421,7 @@ declare class FlowDocument<T = FlowDocumentJSON> implements Disposable {
      * 返回需要渲染的数据
      */
     getRenderDatas<T extends EntityData>(dataRegistry: EntityDataRegistry<T>, containHiddenNodes?: boolean): T[];
+    toNodeJSON(node: FlowNodeEntity): FlowNodeJSON;
     /**
      * 移动节点
      * @param param0
@@ -591,6 +612,11 @@ declare class FlowNodeTransitionData extends EntityData<FlowNodeTransitionSchema
     get isNodeEnd(): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FlowNodeEntityConfig extends EntityOpts {
     document: FlowDocument;
     flowNodeType: FlowNodeType;
@@ -784,6 +810,11 @@ declare class FlowDocumentTransformerEntity extends ConfigEntity<{
     refresh(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FlowRendererStateEntityConfig extends EntityOpts {
 }
 interface FlowRendererState {
@@ -814,6 +845,11 @@ declare class FlowRendererStateEntity extends ConfigEntity<FlowRendererState, Fl
     onNodeHoveredChange(fn: (hoveredNode: FlowNodeEntity | undefined) => void, debounceTime?: number): Disposable;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FlowTransitionLineEnum {
     STRAIGHT_LINE = 0,
     DIVERGE_LINE = 1,
@@ -884,6 +920,11 @@ interface DragNodeProps {
     node: FlowNodeEntity;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FlowLayoutDefault {
     VERTICAL_FIXED_LAYOUT = "vertical-fixed-layout",
     HORIZONTAL_FIXED_LAYOUT = "horizontal-fixed-layout"
@@ -936,6 +977,11 @@ interface FlowLayout {
     getDefaultNodeOrigin(): IPoint;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * 节点渲染相关配置信息，可扩展
  */
@@ -975,6 +1021,10 @@ declare const DefaultSpacingKey: {
      * 普通节点间距。垂直 / 水平
      */
     NODE_SPACING: string;
+    /**
+     * 分支节点间距
+     */
+    BRANCH_SPACING: string;
     /**
      * 圆弧线条 x radius
      */
@@ -1003,6 +1053,9 @@ declare const DefaultSpacingKey: {
 declare const DEFAULT_SPACING: {
     [x: string]: number;
     NULL: number;
+    /**
+     * @deprecated use 'BRANCH_SPACING' instead
+     */
     MARGIN_RIGHT: number;
     INLINE_BLOCK_PADDING_BOTTOM: number;
     INLINE_BLOCKS_PADDING_TOP: number;
@@ -1153,6 +1206,11 @@ declare namespace FlowNodeRegistry {
     function extend(registry: FlowNodeRegistry, extendRegistries: FlowNodeRegistry[]): FlowNodeRegistry;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FlowNodeType = string | number;
 /**
  * Flow node json data
@@ -1202,6 +1260,11 @@ type AddNodeData = FlowNodeJSON & {
     index?: number;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum OperationType {
     addFromNode = "addFromNode",
     deleteFromNode = "deleteFromNode",
@@ -1448,10 +1511,19 @@ interface FlowOperationBaseService extends Disposable {
 }
 declare const FlowOperationBaseService: unique symbol;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface FlowGroupJSON {
     nodeIDs: string[];
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FlowDocumentContainerModule: ContainerModule;
 
 /**
@@ -1543,6 +1615,11 @@ declare class FlowOperationBaseServiceImpl implements FlowOperationBaseService {
     protected doMoveNode(node: FlowNodeEntity, newParent: FlowNodeEntity, index: number): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /** 分组控制器 */
 declare class FlowGroupController {
     readonly groupNode: FlowNodeEntity;
@@ -1568,6 +1645,11 @@ declare class FlowGroupController {
     static create(groupNode?: FlowNodeEntity): FlowGroupController | undefined;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class FlowGroupService {
     readonly entityManager: EntityManager;
     readonly operationService: FlowOperationBaseService;
@@ -1584,6 +1666,11 @@ declare class FlowGroupService {
     static validate(nodes: FlowNodeEntity[]): boolean;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  *
  * @param node 节点 entity

package/dist/index.js

@@ -151,6 +151,10 @@ var DefaultSpacingKey = {
    * 普通节点间距。垂直 / 水平
    */
   NODE_SPACING: "SPACING",
+  /**
+   * 分支节点间距
+   */
+  BRANCH_SPACING: "BRANCH_SPACING",
   /**
    * 圆弧线条 x radius
    */
@@ -177,8 +181,13 @@ var DEFAULT_SPACING = {
   NULL: 0,
   [DefaultSpacingKey.NODE_SPACING]: 32,
   // 普通节点间距。垂直 / 水平
+  [DefaultSpacingKey.BRANCH_SPACING]: 20,
+  // 分支节点间距
+  /**
+   * @deprecated use 'BRANCH_SPACING' instead
+   */
   MARGIN_RIGHT: 20,
-  // 普通节点右边间距
+  // 分支节点右边间距
   INLINE_BLOCK_PADDING_BOTTOM: 16,
   // block 底部留白
   INLINE_BLOCKS_PADDING_TOP: 30,
@@ -1074,37 +1083,7 @@ var FlowNodeEntity = class extends import_core4.Entity {
    * @param newId
    */
   toJSON() {
-    if (this.document.options.toNodeJSON) {
-      return this.document.options.toNodeJSON(this);
-    }
-    const nodesMap = {};
-    let startNodeJSON;
-    this.document.traverse((node) => {
-      const isSystemNode = node.id.startsWith("$");
-      if (isSystemNode) return;
-      const nodeJSONData = this.getJSONData();
-      const nodeJSON = {
-        id: node.id,
-        type: node.flowNodeType
-      };
-      if (nodeJSONData !== void 0) {
-        nodeJSON.data = nodeJSONData;
-      }
-      if (!startNodeJSON) startNodeJSON = nodeJSON;
-      let { parent } = node;
-      if (parent && parent.id.startsWith("$")) {
-        parent = parent.originParent;
-      }
-      const parentJSON = parent ? nodesMap[parent.id] : void 0;
-      if (parentJSON) {
-        if (!parentJSON.blocks) {
-          parentJSON.blocks = [];
-        }
-        parentJSON.blocks.push(nodeJSON);
-      }
-      nodesMap[node.id] = nodeJSON;
-    }, this);
-    return startNodeJSON;
+    return this.document.toNodeJSON(this);
   }
   get isVertical() {
     return this.document.layout.name === "vertical-fixed-layout" /* VERTICAL_FIXED_LAYOUT */;
@@ -2153,6 +2132,39 @@ var FlowDocument = class {
     });
     return result;
   }
+  toNodeJSON(node) {
+    if (this.options.toNodeJSON) {
+      return this.options.toNodeJSON(node);
+    }
+    const nodesMap = {};
+    let startNodeJSON;
+    this.traverse((node2) => {
+      const isSystemNode = node2.id.startsWith("$");
+      if (isSystemNode) return;
+      const nodeJSONData = node2.getJSONData();
+      const nodeJSON = {
+        id: node2.id,
+        type: node2.flowNodeType
+      };
+      if (nodeJSONData !== void 0) {
+        nodeJSON.data = nodeJSONData;
+      }
+      if (!startNodeJSON) startNodeJSON = nodeJSON;
+      let { parent } = node2;
+      if (parent && parent.id.startsWith("$")) {
+        parent = parent.originParent;
+      }
+      const parentJSON = parent ? nodesMap[parent.id] : void 0;
+      if (parentJSON) {
+        if (!parentJSON.blocks) {
+          parentJSON.blocks = [];
+        }
+        parentJSON.blocks.push(nodeJSON);
+      }
+      nodesMap[node2.id] = nodeJSON;
+    }, node);
+    return startNodeJSON;
+  }
   /**
    * 移动节点
    * @param param0