@flowgram.ai/variable-core 0.1.23 → 0.1.25

package/dist/index.js

@@ -64,7 +64,6 @@ __export(src_exports, {
   VariableEngine: () => VariableEngine,
   VariableEngineProvider: () => VariableEngineProvider,
   VariableFieldKeyRenameService: () => VariableFieldKeyRenameService,
-  VariableTable: () => VariableTable,
   injectToAST: () => injectToAST,
   isMatchAST: () => isMatchAST,
   postConstructAST: () => postConstructAST,
@@ -81,8 +80,8 @@ var import_inversify7 = require("inversify");
 // src/variable-engine.ts
 var import_rxjs6 = require("rxjs");
 var import_inversify5 = require("inversify");
-var import_utils10 = require("@flowgram.ai/utils");
-var import_utils11 = require("@flowgram.ai/utils");
+var import_utils8 = require("@flowgram.ai/utils");
+var import_utils9 = require("@flowgram.ai/utils");
 
 // src/utils/toDisposable.tsx
 var import_utils = require("@flowgram.ai/utils");
@@ -112,9 +111,117 @@ var createMemo = () => {
   return memo;
 };
 
+// src/scope/variable-table.ts
+var import_rxjs = require("rxjs");
+var import_utils2 = require("@flowgram.ai/utils");
+var VariableTable = class {
+  constructor(parentTable) {
+    this.parentTable = parentTable;
+    this.table = /* @__PURE__ */ new Map();
+    this.onDataChangeEmitter = new import_utils2.Emitter();
+    this.variables$ = new import_rxjs.Subject();
+    // 监听变量列表中的单个变量变化
+    this.anyVariableChange$ = this.variables$.pipe(
+      (0, import_rxjs.switchMap)(
+        (_variables) => (0, import_rxjs.merge)(
+          ..._variables.map(
+            (_v) => _v.value$.pipe(
+              // 跳过 BehaviorSubject 第一个
+              (0, import_rxjs.skip)(1)
+            )
+          )
+        )
+      ),
+      (0, import_rxjs.share)()
+    );
+    this.onDataChange = this.onDataChangeEmitter.event;
+    this._version = 0;
+  }
+  /**
+   * 监听任意变量变化
+   * @param observer 监听器，变量变化时会吐出值
+   * @returns
+   */
+  onAnyVariableChange(observer) {
+    return subsToDisposable(this.anyVariableChange$.subscribe(observer));
+  }
+  /**
+   * 列表或者任意变量变化
+   * @param observer
+   */
+  onAnyChange(observer) {
+    const disposables = new import_utils2.DisposableCollection();
+    disposables.pushAll([this.onDataChange(observer), this.onAnyVariableChange(observer)]);
+    return disposables;
+  }
+  fireChange() {
+    this._version++;
+    this.onDataChangeEmitter.fire();
+    this.parentTable?.fireChange();
+  }
+  get version() {
+    return this._version;
+  }
+  get variables() {
+    return Array.from(this.table.values());
+  }
+  get variableKeys() {
+    return Array.from(this.table.keys());
+  }
+  /**
+   * 根据 keyPath 找到对应的变量，或 Property 节点
+   * @param keyPath
+   * @returns
+   */
+  getByKeyPath(keyPath) {
+    const [variableKey, ...propertyKeys] = keyPath || [];
+    if (!variableKey) {
+      return;
+    }
+    const variable = this.getVariableByKey(variableKey);
+    return propertyKeys.length ? variable?.getByKeyPath(propertyKeys) : variable;
+  }
+  /**
+   * 根据 key 值找到相应的变量
+   * @param key
+   * @returns
+   */
+  getVariableByKey(key) {
+    return this.table.get(key);
+  }
+  /**
+   * 往 variableTable 添加输出变量
+   * @param variable
+   */
+  addVariableToTable(variable) {
+    this.table.set(variable.key, variable);
+    if (this.parentTable) {
+      this.parentTable.addVariableToTable(variable);
+    }
+    this.variables$.next(this.variables);
+  }
+  /**
+   * 从 variableTable 中移除变量
+   * @param key
+   */
+  removeVariableFromTable(key) {
+    this.table.delete(key);
+    if (this.parentTable) {
+      this.parentTable.removeVariableFromTable(key);
+    }
+    this.variables$.next(this.variables);
+  }
+  dispose() {
+    this.variableKeys.forEach(
+      (_key) => this.parentTable?.removeVariableFromTable(_key)
+    );
+    this.onDataChangeEmitter.dispose();
+  }
+};
+
 // src/scope/scope-chain.ts
 var import_inversify = require("inversify");
-var import_utils2 = require("@flowgram.ai/utils");
+var import_utils3 = require("@flowgram.ai/utils");
 
 // src/providers.ts
 var VariableEngineProvider = Symbol("DynamicVariableEngine");
@@ -123,7 +230,7 @@ var ContainerProvider = Symbol("ContainerProvider");
 // src/scope/scope-chain.ts
 var ScopeChain = class {
   constructor() {
-    this.toDispose = new import_utils2.DisposableCollection();
+    this.toDispose = new import_utils3.DisposableCollection();
   }
   get variableEngine() {
     return this.variableEngineProvider();
@@ -155,7 +262,7 @@ ScopeChain = __decorateClass([
 ], ScopeChain);
 
 // src/scope/scope.ts
-var import_utils9 = require("@flowgram.ai/utils");
+var import_utils7 = require("@flowgram.ai/utils");
 
 // src/ast/types.ts
 var ASTKind = /* @__PURE__ */ ((ASTKind2) => {
@@ -287,10 +394,10 @@ var ASTNodeFlags = /* @__PURE__ */ ((ASTNodeFlags2) => {
 })(ASTNodeFlags || {});
 
 // src/ast/ast-node.ts
-var import_rxjs = require("rxjs");
+var import_rxjs2 = require("rxjs");
 var import_nanoid = require("nanoid");
 var import_fast_equals = require("fast-equals");
-var import_utils3 = require("@flowgram.ai/utils");
+var import_utils4 = require("@flowgram.ai/utils");
 var ASTNode = class _ASTNode {
   /**
    * 构造函数
@@ -321,7 +428,7 @@ var ASTNode = class _ASTNode {
      * AST 节点变化事件，基于 Rxjs 实现
      * - 使用了 BehaviorSubject, 在订阅时会自动触发一次事件，事件为当前值
      */
-    this.value$ = new import_rxjs.BehaviorSubject(this);
+    this.value$ = new import_rxjs2.BehaviorSubject(this);
     /**
      * 子节点
      */
@@ -329,8 +436,8 @@ var ASTNode = class _ASTNode {
     /**
      * 删除节点处理事件列表
      */
-    this.toDispose = new import_utils3.DisposableCollection(
-      import_utils3.Disposable.create(() => {
+    this.toDispose = new import_utils4.DisposableCollection(
+      import_utils4.Disposable.create(() => {
         this.parent?.fireChange();
         this.children.forEach((child) => child.dispose());
       })
@@ -384,7 +491,7 @@ var ASTNode = class _ASTNode {
     });
     this._children.add(child);
     child.toDispose.push(
-      import_utils3.Disposable.create(() => {
+      import_utils4.Disposable.create(() => {
         this._children.delete(child);
       })
     );
@@ -461,8 +568,8 @@ var ASTNode = class _ASTNode {
   subscribe(observer, { selector, debounceAnimation, triggerOnInit } = {}) {
     return subsToDisposable(
       this.value$.pipe(
-        (0, import_rxjs.map)(() => selector ? selector(this) : this),
-        (0, import_rxjs.distinctUntilChanged)(
+        (0, import_rxjs2.map)(() => selector ? selector(this) : this),
+        (0, import_rxjs2.distinctUntilChanged)(
           (a, b) => (0, import_fast_equals.shallowEqual)(a, b),
           (value) => {
             if (value instanceof _ASTNode) {
@@ -472,9 +579,9 @@ var ASTNode = class _ASTNode {
           }
         ),
         // 默认跳过 BehaviorSubject 第一次触发
-        triggerOnInit ? (0, import_rxjs.tap)(() => null) : (0, import_rxjs.skip)(1),
+        triggerOnInit ? (0, import_rxjs2.tap)(() => null) : (0, import_rxjs2.skip)(1),
         // 每个 animationFrame 内所有更新合并成一个
-        debounceAnimation ? (0, import_rxjs.debounceTime)(0, import_rxjs.animationFrameScheduler) : (0, import_rxjs.tap)(() => null)
+        debounceAnimation ? (0, import_rxjs2.debounceTime)(0, import_rxjs2.animationFrameScheduler) : (0, import_rxjs2.tap)(() => null)
       ).subscribe(observer)
     );
   }
@@ -780,7 +887,7 @@ var CustomType = class extends BaseType {
 CustomType.kind = "CustomType" /* CustomType */;
 
 // src/ast/expression/base-expression.ts
-var import_rxjs2 = require("rxjs");
+var import_rxjs3 = require("rxjs");
 var import_fast_equals2 = require("fast-equals");
 
 // src/ast/utils/variable-field.ts
@@ -805,22 +912,22 @@ var BaseExpression = class extends ASTNode {
      * 引用变量
      */
     this._refs = [];
-    this.refreshRefs$ = new import_rxjs2.Subject();
+    this.refreshRefs$ = new import_rxjs3.Subject();
     /**
      * 监听引用变量变化
      * 监听 [a.b.c] -> [a.b]
      */
     this.refs$ = this.refreshRefs$.pipe(
-      (0, import_rxjs2.map)(() => this.getRefFields()),
-      (0, import_rxjs2.distinctUntilChanged)(import_fast_equals2.shallowEqual),
-      (0, import_rxjs2.switchMap)(
-        (refs) => !refs?.length ? (0, import_rxjs2.of)([]) : (0, import_rxjs2.combineLatest)(
+      (0, import_rxjs3.map)(() => this.getRefFields()),
+      (0, import_rxjs3.distinctUntilChanged)(import_fast_equals2.shallowEqual),
+      (0, import_rxjs3.switchMap)(
+        (refs) => !refs?.length ? (0, import_rxjs3.of)([]) : (0, import_rxjs3.combineLatest)(
           refs.map(
-            (ref) => ref ? ref.value$ : (0, import_rxjs2.of)(void 0)
+            (ref) => ref ? ref.value$ : (0, import_rxjs3.of)(void 0)
           )
         )
       ),
-      (0, import_rxjs2.share)()
+      (0, import_rxjs3.share)()
     );
     this.toDispose.push(
       subsToDisposable(
@@ -1058,9 +1165,6 @@ var KeyPathExpressionV2 = class extends BaseExpression {
 };
 KeyPathExpressionV2.kind = "KeyPathExpression" /* KeyPathExpression */;
 
-// src/ast/declaration/variable-declaration.ts
-var import_utils4 = require("@flowgram.ai/utils");
-
 // src/ast/declaration/base-variable-field.ts
 var import_fast_equals5 = require("fast-equals");
 var BaseVariableField = class extends ASTNode {
@@ -1144,13 +1248,6 @@ var VariableDeclaration = class extends BaseVariableField {
   constructor(params) {
     super(params);
     this._order = 0;
-    this.scope.output.addVariableToTable(this);
-    this.toDispose.push(
-      import_utils4.Disposable.create(() => {
-        this.scope.output.setHasChanges();
-        this.scope.output.removeVariableFromTable(this.key);
-      })
-    );
   }
   get order() {
     return this._order;
@@ -1165,7 +1262,9 @@ var VariableDeclaration = class extends BaseVariableField {
   updateOrder(order = 0) {
     if (order !== this._order) {
       this._order = order;
-      this.scope.output.setHasChanges();
+      this.dispatchGlobalEvent({
+        type: "ReSortVariableDeclarations"
+      });
       this.fireChange();
     }
   }
@@ -1478,113 +1577,6 @@ var ASTFactory;
   ASTFactory2.create = (targetType, json) => ({ kind: targetType.kind, ...json });
 })(ASTFactory || (ASTFactory = {}));
 
-// src/scope/variable-table.ts
-var import_rxjs3 = require("rxjs");
-var import_utils5 = require("@flowgram.ai/utils");
-var import_utils6 = require("@flowgram.ai/utils");
-var VariableTable = class {
-  constructor(parentTable) {
-    this.parentTable = parentTable;
-    this.table = /* @__PURE__ */ new Map();
-    this.onDataChangeEmitter = new import_utils5.Emitter();
-    this.variables$ = new import_rxjs3.Subject();
-    // 监听变量列表中的单个变量变化
-    this.anyVariableChange$ = this.variables$.pipe(
-      (0, import_rxjs3.switchMap)(
-        (_variables) => (0, import_rxjs3.merge)(
-          ..._variables.map(
-            (_v) => _v.value$.pipe(
-              // 跳过 BehaviorSubject 第一个
-              (0, import_rxjs3.skip)(1)
-            )
-          )
-        )
-      ),
-      (0, import_rxjs3.share)()
-    );
-    this.onDataChange = this.onDataChangeEmitter.event;
-    this._version = 0;
-  }
-  /**
-   * 监听任意变量变化
-   * @param observer 监听器，变量变化时会吐出值
-   * @returns
-   */
-  onAnyVariableChange(observer) {
-    return subsToDisposable(this.anyVariableChange$.subscribe(observer));
-  }
-  /**
-   * 列表或者任意变量变化
-   * @param observer
-   */
-  onAnyChange(observer) {
-    const disposables = new import_utils6.DisposableCollection();
-    disposables.pushAll([this.onDataChange(observer), this.onAnyVariableChange(observer)]);
-    return disposables;
-  }
-  fireChange() {
-    this._version++;
-    this.onDataChangeEmitter.fire();
-    this.parentTable?.fireChange();
-  }
-  get version() {
-    return this._version;
-  }
-  get variables() {
-    return Array.from(this.table.values());
-  }
-  get variableKeys() {
-    return Array.from(this.table.keys());
-  }
-  /**
-   * 根据 keyPath 找到对应的变量，或 Property 节点
-   * @param keyPath
-   * @returns
-   */
-  getByKeyPath(keyPath) {
-    const [variableKey, ...propertyKeys] = keyPath || [];
-    if (!variableKey) {
-      return;
-    }
-    const variable = this.getVariableByKey(variableKey);
-    return propertyKeys.length ? variable?.getByKeyPath(propertyKeys) : variable;
-  }
-  /**
-   * 根据 key 值找到相应的变量
-   * @param key
-   * @returns
-   */
-  getVariableByKey(key) {
-    return this.table.get(key);
-  }
-  /**
-   * 往 variableTable 添加输出变量
-   * @param variable
-   */
-  addVariableToTable(variable) {
-    this.table.set(variable.key, variable);
-    if (this.parentTable) {
-      this.parentTable.addVariableToTable(variable);
-    }
-    this.variables$.next(this.variables);
-  }
-  /**
-   * 从 variableTable 中移除变量
-   * @param key
-   */
-  removeVariableFromTable(key) {
-    this.table.delete(key);
-    if (this.parentTable) {
-      this.parentTable.removeVariableFromTable(key);
-    }
-    this.variables$.next(this.variables);
-  }
-  dispose() {
-    this.variableKeys.forEach((_key) => this.parentTable?.removeVariableFromTable(_key));
-    this.onDataChangeEmitter.dispose();
-  }
-};
-
 // src/scope/datas/scope-output-data.ts
 var ScopeOutputData = class {
   constructor(scope) {
@@ -1593,7 +1585,7 @@ var ScopeOutputData = class {
     this._hasChanges = false;
     this.variableTable = new VariableTable(scope.variableEngine.globalVariableTable);
     this.scope.toDispose.pushAll([
-      // AST 根节点更新时，检查在这次 AST 变化期间节点是否有变化
+      // When root AST node is updated, check if there are any changes during this AST change
       this.scope.ast.subscribe(() => {
         if (this._hasChanges) {
           this.memo.clear();
@@ -1602,6 +1594,19 @@ var ScopeOutputData = class {
           this._hasChanges = false;
         }
       }),
+      this.scope.event.on("DisposeAST", (_action) => {
+        if (_action.ast?.kind === "VariableDeclaration" /* VariableDeclaration */) {
+          this.removeVariableFromTable(_action.ast.key);
+        }
+      }),
+      this.scope.event.on("NewAST", (_action) => {
+        if (_action.ast?.kind === "VariableDeclaration" /* VariableDeclaration */) {
+          this.addVariableToTable(_action.ast);
+        }
+      }),
+      this.scope.event.on("ReSortVariableDeclarations", () => {
+        this._hasChanges = true;
+      }),
       this.variableTable
     ]);
   }
@@ -1618,7 +1623,7 @@ var ScopeOutputData = class {
     return this.variableTable.onAnyVariableChange.bind(this.variableTable);
   }
   /**
-   * 作用域输出变量
+   * Scope Output Variable Declarations
    */
   get variables() {
     return this.memo(
@@ -1627,7 +1632,7 @@ var ScopeOutputData = class {
     );
   }
   /**
-   * 输出的变量 keys
+   * Output Variable Keys
    */
   get variableKeys() {
     return this.memo("variableKeys", () => this.variableTable.variableKeys);
@@ -1639,10 +1644,6 @@ var ScopeOutputData = class {
     this.variableTable.addVariableToTable(variable);
     this._hasChanges = true;
   }
-  // 标记为发生了变化，用于变量排序变化的场景
-  setHasChanges() {
-    this._hasChanges = true;
-  }
   removeVariableFromTable(key) {
     this.variableTable.removeVariableFromTable(key);
     this._hasChanges = true;
@@ -1650,7 +1651,9 @@ var ScopeOutputData = class {
   getVariableByKey(key) {
     return this.variableTable.getVariableByKey(key);
   }
-  // 通知覆盖作用域更新可用变量
+  /**
+   *
+   */
   notifyCoversChange() {
     this.scope.coverScopes.forEach((scope) => scope.available.refresh());
   }
@@ -1660,8 +1663,8 @@ var ScopeOutputData = class {
 var import_rxjs4 = require("rxjs");
 var import_lodash4 = require("lodash");
 var import_fast_equals7 = require("fast-equals");
-var import_utils7 = require("@flowgram.ai/utils");
-var import_utils8 = require("@flowgram.ai/utils");
+var import_utils5 = require("@flowgram.ai/utils");
+var import_utils6 = require("@flowgram.ai/utils");
 var ScopeAvailableData = class {
   constructor(scope) {
     this.scope = scope;
@@ -1692,7 +1695,7 @@ var ScopeAvailableData = class {
       ),
       (0, import_rxjs4.share)()
     );
-    this.onDataChangeEmitter = new import_utils8.Emitter();
+    this.onDataChangeEmitter = new import_utils6.Emitter();
     /**
      * 监听变量列表变化 + 任意子变量变化
      */
@@ -1706,7 +1709,7 @@ var ScopeAvailableData = class {
       this.onAnyVariableChange(() => {
         this.onDataChangeEmitter.fire(this._variables);
       }),
-      import_utils7.Disposable.create(() => {
+      import_utils5.Disposable.create(() => {
         this.refresh$.complete();
         this.refresh$.unsubscribe();
       })
@@ -1804,7 +1807,7 @@ var Scope = class {
      * 数据缓存
      */
     this.memo = createMemo();
-    this.toDispose = new import_utils9.DisposableCollection();
+    this.toDispose = new import_utils7.DisposableCollection();
     this.onDispose = this.toDispose.onDispose;
     this.id = options.id;
     this.meta = options.meta || {};
@@ -1813,7 +1816,7 @@ var Scope = class {
     this.ast = this.variableEngine.astRegisters.createAST(
       {
         kind: "MapNode" /* MapNode */,
-        key: this.id
+        key: String(this.id)
       },
       {
         scope: this
@@ -1857,16 +1860,16 @@ var VariableEngine = class {
   constructor(chain, astRegisters) {
     this.chain = chain;
     this.astRegisters = astRegisters;
-    this.toDispose = new import_utils10.DisposableCollection();
+    this.toDispose = new import_utils8.DisposableCollection();
     this.memo = createMemo();
     this.scopeMap = /* @__PURE__ */ new Map();
     this.globalEvent$ = new import_rxjs6.Subject();
-    this.onScopeChangeEmitter = new import_utils11.Emitter();
+    this.onScopeChangeEmitter = new import_utils9.Emitter();
     this.globalVariableTable = new VariableTable();
     this.onScopeChange = this.onScopeChangeEmitter.event;
     this.toDispose.pushAll([
       chain,
-      import_utils10.Disposable.create(() => {
+      import_utils8.Disposable.create(() => {
         this.getAllScopes().forEach((scope) => scope.dispose());
         this.globalVariableTable.dispose();
       })
@@ -1886,11 +1889,18 @@ var VariableEngine = class {
   removeScopeById(scopeId) {
     this.getScopeById(scopeId)?.dispose();
   }
-  // 获取 Scope，如果 Scope 存在且类型相同，则会直接使用
-  createScope(id, meta) {
+  /**
+   * Get Scope, if Scope exists and type is same, will use it directly
+   * @param id scope id
+   * @param meta scope meta, defined by user
+   * @param ScopeConstructor scope constructor, default is Scope. you can extends Scope to create your own scope
+   * @returns
+   */
+  createScope(id, meta, options = {}) {
+    const { ScopeConstructor = Scope } = options;
     let scope = this.getScopeById(id);
     if (!scope) {
-      scope = new Scope({ variableEngine: this, meta, id });
+      scope = new ScopeConstructor({ variableEngine: this, meta, id });
       this.scopeMap.set(id, scope);
       this.onScopeChangeEmitter.fire({ type: "add", scope });
       scope.toDispose.pushAll([
@@ -1950,13 +1960,13 @@ VariableEngine = __decorateClass([
 // src/services/variable-field-key-rename-service.ts
 var import_lodash5 = require("lodash");
 var import_inversify6 = require("inversify");
-var import_utils12 = require("@flowgram.ai/utils");
+var import_utils10 = require("@flowgram.ai/utils");
 var VariableFieldKeyRenameService = class {
   constructor() {
-    this.toDispose = new import_utils12.DisposableCollection();
-    this.renameEmitter = new import_utils12.Emitter();
+    this.toDispose = new import_utils10.DisposableCollection();
+    this.renameEmitter = new import_utils10.Emitter();
     // 没有被 rename 的字段通过 disposeInList 透出，让业务区分变量是 rename 删除的，还是真正从列表中删除的
-    this.disposeInListEmitter = new import_utils12.Emitter();
+    this.disposeInListEmitter = new import_utils10.Emitter();
     this.onRename = this.renameEmitter.event;
     this.onDisposeInList = this.disposeInListEmitter.event;
   }
@@ -2116,7 +2126,6 @@ function useAvailableVariables() {
   VariableEngine,
   VariableEngineProvider,
   VariableFieldKeyRenameService,
-  VariableTable,
   injectToAST,
   isMatchAST,
   postConstructAST,