@flowgram.ai/variable-layout 0.2.16 → 0.2.18

package/dist/index.d.ts

@@ -1,8 +1,13 @@
-import { Scope, VariableEngine, ASTNodeJSON, ASTNode, ScopeChain } from '@flowgram.ai/variable-core';
+import { Scope, VariableEngine, ASTNodeJSON, ASTNode, BaseVariableField, ScopeChain } from '@flowgram.ai/variable-core';
 import { FlowNodeEntity, FlowDocument, FlowVirtualTree } from '@flowgram.ai/document';
 import { EntityData, EntityManager } from '@flowgram.ai/core';
 import { interfaces } from 'inversify';
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare enum FlowNodeScopeTypeEnum {
     public = "public",
     private = "private"
@@ -16,7 +21,13 @@ interface ScopeVirtualNode {
     flowNodeType: 'virtualNode';
 }
 type ScopeChainNode = FlowNodeEntity | ScopeVirtualNode;
-type FlowNodeScope = Scope<FlowNodeScopeMeta>;
+interface FlowNodeScope extends Scope<FlowNodeScopeMeta> {
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
 interface Options {
     variableEngine: VariableEngine;
@@ -95,8 +106,25 @@ declare class FlowNodeVariableData extends EntityData {
     getDefaultData(): {};
     constructor(entity: FlowNodeEntity, opts: Options);
     initPrivate(): FlowNodeScope;
+    /**
+     * Find a variable field by key path in the public scope by scope chain.
+     * @param keyPath - The key path of the variable field.
+     * @returns The variable field, or undefined if not found.
+     */
+    getByKeyPath(keyPath: string[]): BaseVariableField | undefined;
+    /**
+     * Find a variable field by key path in the private scope by scope chain.
+     * @param keyPath - The key path of the variable field.
+     * @returns The variable field, or undefined if not found.
+     */
+    getByKeyPathInPrivate(keyPath: string[]): BaseVariableField | undefined;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface TransformerContext {
     scope: FlowNodeScope;
     document: FlowDocument;
@@ -105,13 +133,28 @@ interface TransformerContext {
 type IScopeTransformer = (scopes: Scope[], ctx: TransformerContext) => Scope[];
 declare class ScopeChainTransformService {
     protected configs?: VariableLayoutConfig | undefined;
-    protected transformDepsFns: IScopeTransformer[];
-    protected transformCoversFns: IScopeTransformer[];
+    protected transformerMap: Map<string, {
+        transformDeps: IScopeTransformer;
+        transformCovers: IScopeTransformer;
+    }>;
     document: FlowDocument;
     variableEngine: VariableEngine;
     constructor(configs?: VariableLayoutConfig | undefined);
-    registerTransformDeps(transformer: IScopeTransformer): void;
-    registerTransformCovers(transformer: IScopeTransformer): void;
+    /**
+     * check if transformer registered
+     * @param transformerId used to identify transformer, prevent duplicated
+     * @returns
+     */
+    hasTransformer(transformerId: string): boolean;
+    /**
+     * register new transform function
+     * @param transformerId used to identify transformer, prevent duplicated transformer
+     * @param transformer
+     */
+    registerTransformer(transformerId: string, transformer: {
+        transformDeps: IScopeTransformer;
+        transformCovers: IScopeTransformer;
+    }): void;
     transformDeps(scopes: Scope[], { scope }: {
         scope: Scope;
     }): Scope[];
@@ -120,6 +163,11 @@ declare class ScopeChainTransformService {
     }): Scope[];
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface VariableLayoutConfig {
     /**
      * 节点的子节点输出变量，不能被后续节点所访问，用于固定布局场景
@@ -128,23 +176,27 @@ interface VariableLayoutConfig {
      */
     isNodeChildrenPrivate?: (node: ScopeChainNode) => boolean;
     /**
-     * 用于自由画布场景，部分场景通过连线或者其他交互形式来表达节点之间的父子关系，需要可配置化
+     * 用于固定布局场景时：父子中间存在大量无用节点（如 inlineBlocks 等，需要配置化略过）
+     * 用于自由画布场景时：部分场景通过连线或者其他交互形式来表达节点之间的父子关系，需可配置化
      */
-    getFreeChildren?: (node: FlowNodeEntity) => FlowNodeEntity[];
-    getFreeParent?: (node: FlowNodeEntity) => FlowNodeEntity | undefined;
+    getNodeChildren?: (node: FlowNodeEntity) => FlowNodeEntity[];
+    getNodeParent?: (node: FlowNodeEntity) => FlowNodeEntity | undefined;
     /**
-     * @deprecated
      * 对依赖作用域进行微调
      */
     transformDeps?: IScopeTransformer;
     /**
-     * @deprecated
      * 对依赖作用域进行微调
      */
     transformCovers?: IScopeTransformer;
 }
 declare const VariableLayoutConfig: unique symbol;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * 自由布局作用域链实现
  */
@@ -159,11 +211,16 @@ declare class FreeLayoutScopeChain extends ScopeChain {
     protected getAllOutputLayerNodes(curr: FlowNodeEntity): FlowNodeEntity[];
     getDeps(scope: FlowNodeScope): FlowNodeScope[];
     getCovers(scope: FlowNodeScope): FlowNodeScope[];
-    getChildren(node: FlowNodeEntity): FlowNodeEntity[];
-    getParent(node: FlowNodeEntity): FlowNodeEntity | undefined;
+    getNodeChildren(node: FlowNodeEntity): FlowNodeEntity[];
+    getNodeParent(node: FlowNodeEntity): FlowNodeEntity | undefined;
     sortAll(): Scope[];
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * 基于 FlowVirtualTree 的 ScopeOrder 实现
  */
@@ -183,39 +240,18 @@ declare class FixedLayoutScopeChain extends ScopeChain {
     private getAllSortedChildScope;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class GlobalScope extends Scope {
     static readonly ID: unique symbol;
-    static is(scope: Scope): scope is GlobalScope;
-    /**
-     * Sets a variable in the Global Scope with the given key and JSON value.
-     *
-     * @param key - The key under which the variable will be stored.
-     * @param json - The JSON value to store.
-     * @returns The updated AST node.
-     */
-    setVar(key: string, json: ASTNodeJSON): ASTNode;
-    /**
-     * Sets a variable in the Global Scope with the default key 'outputs'.
-     *
-     * @param json - The JSON value to store.
-     * @returns The updated AST node.
-     */
-    setVar(json: ASTNodeJSON): ASTNode;
-    /**
-     * Retrieves a variable from the Global Scope by key.
-     *
-     * @param key - The key of the variable to retrieve. Defaults to 'outputs'.
-     * @returns The value of the variable, or undefined if not found.
-     */
-    getVar(key?: string): ASTNode<any, any> | undefined;
-    /**
-     * Clears a variable from the Global Scope by key.
-     *
-     * @param key - The key of the variable to clear. Defaults to 'outputs'.
-     * @returns The updated AST node.
-     */
-    clearVar(key?: string): void;
+    static is(scope: Scope): boolean;
 }
 declare const bindGlobalScope: (bind: interfaces.Bind) => void;
 
-export { FixedLayoutScopeChain, type FlowNodeScope, type FlowNodeScopeMeta, FlowNodeScopeTypeEnum as FlowNodeScopeType, FlowNodeVariableData, FreeLayoutScopeChain, GlobalScope, ScopeChainTransformService, VariableLayoutConfig, bindGlobalScope };
+declare function getNodeScope(node: FlowNodeEntity): FlowNodeScope;
+declare function getNodePrivateScope(node: FlowNodeEntity): FlowNodeScope;
+
+export { FixedLayoutScopeChain, type FlowNodeScope, type FlowNodeScopeMeta, FlowNodeScopeTypeEnum as FlowNodeScopeType, FlowNodeVariableData, FreeLayoutScopeChain, GlobalScope, ScopeChainTransformService, VariableLayoutConfig, bindGlobalScope, getNodePrivateScope, getNodeScope };

package/dist/index.js

@@ -36,7 +36,9 @@ __export(src_exports, {
   GlobalScope: () => GlobalScope,
   ScopeChainTransformService: () => ScopeChainTransformService,
   VariableLayoutConfig: () => VariableLayoutConfig,
-  bindGlobalScope: () => bindGlobalScope
+  bindGlobalScope: () => bindGlobalScope,
+  getNodePrivateScope: () => getNodePrivateScope,
+  getNodeScope: () => getNodeScope
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -153,6 +155,22 @@ var FlowNodeVariableData = class extends import_core.EntityData {
     }
     return this._private;
   }
+  /**
+   * Find a variable field by key path in the public scope by scope chain.
+   * @param keyPath - The key path of the variable field.
+   * @returns The variable field, or undefined if not found.
+   */
+  getByKeyPath(keyPath) {
+    return this.public.available.getByKeyPath(keyPath);
+  }
+  /**
+   * Find a variable field by key path in the private scope by scope chain.
+   * @param keyPath - The key path of the variable field.
+   * @returns The variable field, or undefined if not found.
+   */
+  getByKeyPathInPrivate(keyPath) {
+    return this.private?.available.getByKeyPath(keyPath);
+  }
 };
 FlowNodeVariableData.type = "FlowNodeVariableData";
 
@@ -171,43 +189,59 @@ var import_inversify = require("inversify");
 var import_variable_core = require("@flowgram.ai/variable-core");
 var import_document = require("@flowgram.ai/document");
 var import_core2 = require("@flowgram.ai/core");
+var passthrough = (scopes, ctx) => scopes;
 var ScopeChainTransformService = class {
   constructor(configs) {
     this.configs = configs;
-    this.transformDepsFns = [];
-    this.transformCoversFns = [];
-    if (this.configs?.transformDeps) {
-      this.transformDepsFns.push(this.configs.transformDeps);
-    }
-    if (this.configs?.transformCovers) {
-      this.transformCoversFns.push(this.configs.transformCovers);
+    this.transformerMap = /* @__PURE__ */ new Map();
+    if (this.configs?.transformDeps || this.configs?.transformCovers) {
+      this.transformerMap.set("VARIABLE_LAYOUT_CONFIG", {
+        transformDeps: this.configs.transformDeps || passthrough,
+        transformCovers: this.configs.transformCovers || passthrough
+      });
     }
   }
-  registerTransformDeps(transformer) {
-    this.transformDepsFns.push(transformer);
+  /**
+   * check if transformer registered
+   * @param transformerId used to identify transformer, prevent duplicated
+   * @returns
+   */
+  hasTransformer(transformerId) {
+    return this.transformerMap.has(transformerId);
   }
-  registerTransformCovers(transformer) {
-    this.transformCoversFns.push(transformer);
+  /**
+   * register new transform function
+   * @param transformerId used to identify transformer, prevent duplicated transformer
+   * @param transformer
+   */
+  registerTransformer(transformerId, transformer) {
+    this.transformerMap.set(transformerId, transformer);
   }
   transformDeps(scopes, { scope }) {
-    return this.transformDepsFns.reduce(
-      (scopes2, transformer) => transformer(scopes2, {
+    return Array.from(this.transformerMap.values()).reduce((scopes2, transformer) => {
+      if (!transformer.transformDeps) {
+        return scopes2;
+      }
+      scopes2 = transformer.transformDeps(scopes2, {
         scope,
         document: this.document,
         variableEngine: this.variableEngine
-      }),
-      scopes
-    );
+      });
+      return scopes2;
+    }, scopes);
   }
   transformCovers(scopes, { scope }) {
-    return this.transformCoversFns.reduce(
-      (scopes2, transformer) => transformer(scopes2, {
+    return Array.from(this.transformerMap.values()).reduce((scopes2, transformer) => {
+      if (!transformer.transformCovers) {
+        return scopes2;
+      }
+      scopes2 = transformer.transformCovers(scopes2, {
         scope,
         document: this.document,
         variableEngine: this.variableEngine
-      }),
-      scopes
-    );
+      });
+      return scopes2;
+    }, scopes);
   }
 };
 __decorateClass([
@@ -229,33 +263,6 @@ var GlobalScope = class extends import_variable_core2.Scope {
   static is(scope) {
     return scope.id === GlobalScope.ID;
   }
-  setVar(arg1, arg2) {
-    if (typeof arg1 === "string" && arg2 !== void 0) {
-      return this.ast.set(arg1, arg2);
-    }
-    if (typeof arg1 === "object" && arg2 === void 0) {
-      return this.ast.set("outputs", arg1);
-    }
-    throw new Error("Invalid arguments");
-  }
-  /**
-   * Retrieves a variable from the Global Scope by key.
-   *
-   * @param key - The key of the variable to retrieve. Defaults to 'outputs'.
-   * @returns The value of the variable, or undefined if not found.
-   */
-  getVar(key = "outputs") {
-    return this.ast.get(key);
-  }
-  /**
-   * Clears a variable from the Global Scope by key.
-   *
-   * @param key - The key of the variable to clear. Defaults to 'outputs'.
-   * @returns The updated AST node.
-   */
-  clearVar(key = "outputs") {
-    return this.ast.remove(key);
-  }
 };
 GlobalScope.ID = Symbol("GlobalScope");
 GlobalScope = __decorateClass([
@@ -298,16 +305,16 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
   }
   // 获取同一层级所有输入节点
   getAllInputLayerNodes(curr) {
-    const currParent = this.getParent(curr);
+    const currParent = this.getNodeParent(curr);
     return (curr.getData(import_free_layout_core.WorkflowNodeLinesData)?.allInputNodes || []).filter(
-      (_node) => this.getParent(_node) === currParent
+      (_node) => this.getNodeParent(_node) === currParent
     );
   }
   // 获取同一层级所有输出节点
   getAllOutputLayerNodes(curr) {
-    const currParent = this.getParent(curr);
+    const currParent = this.getNodeParent(curr);
     return (curr.getData(import_free_layout_core.WorkflowNodeLinesData)?.allOutputNodes || []).filter(
-      (_node) => this.getParent(_node) === currParent
+      (_node) => this.getNodeParent(_node) === currParent
     );
   }
   getDeps(scope) {
@@ -326,7 +333,7 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
       if (currVarData?.private && scope !== currVarData.private) {
         deps.push(currVarData.private);
       }
-      curr = this.getParent(curr);
+      curr = this.getNodeParent(curr);
     }
     const globalScope = this.variableEngine.getScopeById(GlobalScope.ID);
     if (globalScope) {
@@ -337,7 +344,8 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
   }
   getCovers(scope) {
     if (GlobalScope.is(scope)) {
-      return this.variableEngine.getAllScopes({ sort: true }).filter((_scope) => !GlobalScope.is(_scope));
+      const scopes2 = this.variableEngine.getAllScopes({ sort: true }).filter((_scope) => !GlobalScope.is(_scope));
+      return this.transformService.transformCovers(scopes2, { scope });
     }
     const { node } = scope.meta || {};
     if (!node) {
@@ -346,7 +354,7 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
     const isPrivate = scope.meta.type === "private" /* private */;
     const queue = [];
     if (isPrivate) {
-      queue.push(...this.getChildren(node));
+      queue.push(...this.getNodeChildren(node));
     } else {
       queue.push(...this.getAllOutputLayerNodes(node) || []);
     }
@@ -355,7 +363,7 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
       const _node = queue.shift();
       const variableData = _node.getData(FlowNodeVariableData);
       scopes.push(...variableData.allScopes);
-      const children = _node && this.getChildren(_node);
+      const children = _node && this.getNodeChildren(_node);
       if (children?.length) {
         queue.push(...children);
       }
@@ -367,9 +375,9 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
     const uniqScopes = Array.from(new Set(scopes));
     return this.transformService.transformCovers(uniqScopes, { scope });
   }
-  getChildren(node) {
-    if (this.configs?.getFreeChildren) {
-      return this.configs.getFreeChildren?.(node);
+  getNodeChildren(node) {
+    if (this.configs?.getNodeChildren) {
+      return this.configs.getNodeChildren?.(node);
     }
     const nodeMeta = node.getNodeMeta();
     const subCanvas = nodeMeta.subCanvas?.(node);
@@ -382,9 +390,9 @@ var FreeLayoutScopeChain = class extends import_variable_core3.ScopeChain {
     }
     return this.tree.getChildren(node);
   }
-  getParent(node) {
-    if (this.configs?.getFreeParent) {
-      return this.configs.getFreeParent(node);
+  getNodeParent(node) {
+    if (this.configs?.getNodeParent) {
+      return this.configs.getNodeParent(node);
     }
     let parent = node.document.originTree.getParent(node);
     while (parent?.flowNodeType === import_document2.FlowNodeBaseType.GROUP) {
@@ -506,7 +514,8 @@ var FixedLayoutScopeChain = class extends import_variable_core4.ScopeChain {
       return this.transformService.transformCovers([], { scope });
     }
     if (GlobalScope.is(scope)) {
-      return this.variableEngine.getAllScopes({ sort: true }).filter((_scope) => !GlobalScope.is(_scope));
+      const scopes = this.variableEngine.getAllScopes({ sort: true }).filter((_scope) => !GlobalScope.is(_scope));
+      return this.transformService.transformCovers(scopes, { scope });
     }
     const node = scope.meta.node;
     if (!node) {
@@ -631,6 +640,14 @@ FixedLayoutScopeChain = __decorateClass([
   __decorateParam(1, (0, import_inversify4.optional)()),
   __decorateParam(1, (0, import_inversify4.inject)(VariableLayoutConfig))
 ], FixedLayoutScopeChain);
+
+// src/utils.ts
+function getNodeScope(node) {
+  return node.getData(FlowNodeVariableData).public;
+}
+function getNodePrivateScope(node) {
+  return node.getData(FlowNodeVariableData).initPrivate();
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   FixedLayoutScopeChain,
@@ -640,6 +657,8 @@ FixedLayoutScopeChain = __decorateClass([
   GlobalScope,
   ScopeChainTransformService,
   VariableLayoutConfig,
-  bindGlobalScope
+  bindGlobalScope,
+  getNodePrivateScope,
+  getNodeScope
 });
 //# sourceMappingURL=index.js.map