@flowgram.ai/variable-core 0.1.0-alpha.7 → 0.1.0-alpha.9

package/dist/esm/index.js

@@ -16,7 +16,7 @@ import { ContainerModule } from "inversify";
 // src/variable-engine.ts
 import { Subject as Subject5 } from "rxjs";
 import { inject as inject2, injectable as injectable3, preDestroy } from "inversify";
-import { Disposable as Disposable6, DisposableCollection as DisposableCollection5 } from "@flowgram.ai/utils";
+import { Disposable as Disposable4, DisposableCollection as DisposableCollection5 } from "@flowgram.ai/utils";
 import { Emitter as Emitter3 } from "@flowgram.ai/utils";
 
 // src/utils/toDisposable.tsx
@@ -47,9 +47,117 @@ var createMemo = () => {
   return memo;
 };
 
+// src/scope/variable-table.ts
+import { Subject, merge, share, skip, switchMap } from "rxjs";
+import { DisposableCollection, Emitter } from "@flowgram.ai/utils";
+var VariableTable = class {
+  constructor(parentTable) {
+    this.parentTable = parentTable;
+    this.table = /* @__PURE__ */ new Map();
+    this.onDataChangeEmitter = new Emitter();
+    this.variables$ = new Subject();
+    // 监听变量列表中的单个变量变化
+    this.anyVariableChange$ = this.variables$.pipe(
+      switchMap(
+        (_variables) => merge(
+          ..._variables.map(
+            (_v) => _v.value$.pipe(
+              // 跳过 BehaviorSubject 第一个
+              skip(1)
+            )
+          )
+        )
+      ),
+      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 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
 import { inject, injectable } from "inversify";
-import { DisposableCollection } from "@flowgram.ai/utils";
+import { DisposableCollection as DisposableCollection2 } from "@flowgram.ai/utils";
 
 // src/providers.ts
 var VariableEngineProvider = Symbol("DynamicVariableEngine");
@@ -58,7 +166,7 @@ var ContainerProvider = Symbol("ContainerProvider");
 // src/scope/scope-chain.ts
 var ScopeChain = class {
   constructor() {
-    this.toDispose = new DisposableCollection();
+    this.toDispose = new DisposableCollection2();
   }
   get variableEngine() {
     return this.variableEngineProvider();
@@ -109,7 +217,7 @@ var ASTKind = /* @__PURE__ */ ((ASTKind2) => {
   ASTKind2["VariableDeclarationList"] = "VariableDeclarationList";
   ASTKind2["KeyPathExpression"] = "KeyPathExpression";
   ASTKind2["EnumerateExpression"] = "EnumerateExpression";
-  ASTKind2["ExpressionList"] = "ExpressionList";
+  ASTKind2["WrapArrayExpression"] = "WrapArrayExpression";
   ASTKind2["ListNode"] = "ListNode";
   ASTKind2["DataNode"] = "DataNode";
   ASTKind2["MapNode"] = "MapNode";
@@ -228,12 +336,12 @@ import {
   debounceTime,
   distinctUntilChanged,
   map,
-  skip,
+  skip as skip2,
   tap
 } from "rxjs";
 import { nanoid } from "nanoid";
 import { shallowEqual } from "fast-equals";
-import { Disposable as Disposable2, DisposableCollection as DisposableCollection2 } from "@flowgram.ai/utils";
+import { Disposable as Disposable2, DisposableCollection as DisposableCollection3 } from "@flowgram.ai/utils";
 var ASTNode = class _ASTNode {
   /**
    * 构造函数
@@ -272,7 +380,7 @@ var ASTNode = class _ASTNode {
     /**
      * 删除节点处理事件列表
      */
-    this.toDispose = new DisposableCollection2(
+    this.toDispose = new DisposableCollection3(
       Disposable2.create(() => {
         this.parent?.fireChange();
         this.children.forEach((child) => child.dispose());
@@ -415,7 +523,7 @@ var ASTNode = class _ASTNode {
           }
         ),
         // 默认跳过 BehaviorSubject 第一次触发
-        triggerOnInit ? tap(() => null) : skip(1),
+        triggerOnInit ? tap(() => null) : skip2(1),
         // 每个 animationFrame 内所有更新合并成一个
         debounceAnimation ? debounceTime(0, animationFrameScheduler) : tap(() => null)
       ).subscribe(observer)
@@ -451,7 +559,7 @@ var BaseType = class extends ASTNode {
     this.flags = 8 /* BasicType */;
   }
   /**
-   * 类型是否一致，节点有额外信息判断，请参考 extraTypeInfoEqual
+   * 类型是否一致
    * @param targetTypeJSON
    */
   isTypeEqual(targetTypeJSONOrKind) {
@@ -470,6 +578,10 @@ var BaseType = class extends ASTNode {
   getByKeyPath(keyPath = []) {
     throw new Error(`Get By Key Path is not implemented for Type: ${this.kind}`);
   }
+  /**
+   * Get AST JSON for current base type
+   * @returns
+   */
   toJSON() {
     return {
       kind: this.kind
@@ -726,11 +838,11 @@ CustomType.kind = "CustomType" /* CustomType */;
 import {
   distinctUntilChanged as distinctUntilChanged2,
   map as map2,
-  switchMap,
+  switchMap as switchMap2,
   combineLatest,
   of,
-  Subject,
-  share
+  Subject as Subject2,
+  share as share2
 } from "rxjs";
 import { shallowEqual as shallowEqual2 } from "fast-equals";
 
@@ -756,7 +868,7 @@ var BaseExpression = class extends ASTNode {
      * 引用变量
      */
     this._refs = [];
-    this.refreshRefs$ = new Subject();
+    this.refreshRefs$ = new Subject2();
     /**
      * 监听引用变量变化
      * 监听 [a.b.c] -> [a.b]
@@ -764,14 +876,14 @@ var BaseExpression = class extends ASTNode {
     this.refs$ = this.refreshRefs$.pipe(
       map2(() => this.getRefFields()),
       distinctUntilChanged2(shallowEqual2),
-      switchMap(
+      switchMap2(
         (refs) => !refs?.length ? of([]) : combineLatest(
           refs.map(
             (ref) => ref ? ref.value$ : of(void 0)
           )
         )
       ),
-      share()
+      share2()
     );
     this.toDispose.push(
       subsToDisposable(
@@ -805,29 +917,6 @@ var BaseExpression = class extends ASTNode {
   }
 };
 
-// src/ast/expression/expression-list.ts
-var ExpressionList = class extends ASTNode {
-  fromJSON({ expressions }) {
-    this.expressions = expressions.map((_expression, idx) => {
-      const prevExpression = this.expressions[idx];
-      if (prevExpression.kind !== _expression.kind) {
-        prevExpression.dispose();
-        this.fireChange();
-        return this.createChildNode(_expression);
-      }
-      prevExpression.fromJSON(_expression);
-      return prevExpression;
-    });
-  }
-  toJSON() {
-    return {
-      kind: "ExpressionList" /* ExpressionList */,
-      properties: this.expressions.map((_expression) => _expression.toJSON())
-    };
-  }
-};
-ExpressionList.kind = "ExpressionList" /* ExpressionList */;
-
 // src/ast/expression/keypath-expression.ts
 import { shallowEqual as shallowEqual3 } from "fast-equals";
 var KeyPathExpression = class extends BaseExpression {
@@ -1009,8 +1098,45 @@ var KeyPathExpressionV2 = class extends BaseExpression {
 };
 KeyPathExpressionV2.kind = "KeyPathExpression" /* KeyPathExpression */;
 
-// src/ast/declaration/variable-declaration.ts
-import { Disposable as Disposable3 } from "@flowgram.ai/utils";
+// src/ast/expression/wrap-array-expression.ts
+var WrapArrayExpression = class extends BaseExpression {
+  get wrapFor() {
+    return this._wrapFor;
+  }
+  get returnType() {
+    return this._returnType;
+  }
+  refreshReturnType() {
+    const childReturnTypeJSON = this.wrapFor?.returnType?.toJSON();
+    this.updateChildNodeByKey("_returnType", {
+      kind: "Array" /* Array */,
+      items: childReturnTypeJSON
+    });
+  }
+  getRefFields() {
+    return [];
+  }
+  fromJSON({ wrapFor: expression }) {
+    this.updateChildNodeByKey("_wrapFor", expression);
+  }
+  toJSON() {
+    return {
+      kind: "WrapArrayExpression" /* WrapArrayExpression */,
+      wrapFor: this.wrapFor?.toJSON()
+    };
+  }
+  init() {
+    this.toDispose.push(
+      this.subscribe(this.refreshReturnType, {
+        selector: (curr) => curr.wrapFor?.returnType
+      })
+    );
+  }
+};
+WrapArrayExpression.kind = "WrapArrayExpression" /* WrapArrayExpression */;
+__decorateClass([
+  postConstructAST()
+], WrapArrayExpression.prototype, "init", 1);
 
 // src/ast/declaration/base-variable-field.ts
 import { shallowEqual as shallowEqual5 } from "fast-equals";
@@ -1095,13 +1221,6 @@ var VariableDeclaration = class extends BaseVariableField {
   constructor(params) {
     super(params);
     this._order = 0;
-    this.scope.output.addVariableToTable(this);
-    this.toDispose.push(
-      Disposable3.create(() => {
-        this.scope.output.setHasChanges();
-        this.scope.output.removeVariableFromTable(this.key);
-      })
-    );
   }
   get order() {
     return this._order;
@@ -1116,7 +1235,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();
     }
   }
@@ -1321,9 +1442,9 @@ var ASTRegisters = class {
     this.registerAST(Property);
     this.registerAST(VariableDeclaration);
     this.registerAST(VariableDeclarationList);
-    this.registerAST(KeyPathExpression);
+    this.registerAST(KeyPathExpressionV2);
     this.registerAST(EnumerateExpression);
-    this.registerAST(ExpressionList);
+    this.registerAST(WrapArrayExpression);
     this.registerAST(MapNode);
     this.registerAST(DataNode);
   }
@@ -1426,116 +1547,13 @@ var ASTFactory;
     kind: "KeyPathExpression" /* KeyPathExpression */,
     ...json
   });
+  ASTFactory2.createWrapArrayExpression = (json) => ({
+    kind: "WrapArrayExpression" /* WrapArrayExpression */,
+    ...json
+  });
   ASTFactory2.create = (targetType, json) => ({ kind: targetType.kind, ...json });
 })(ASTFactory || (ASTFactory = {}));
 
-// src/scope/variable-table.ts
-import { Subject as Subject2, merge, share as share2, skip as skip2, switchMap as switchMap2 } from "rxjs";
-import { Emitter } from "@flowgram.ai/utils";
-import { DisposableCollection as DisposableCollection3 } from "@flowgram.ai/utils";
-var VariableTable = class {
-  constructor(parentTable) {
-    this.parentTable = parentTable;
-    this.table = /* @__PURE__ */ new Map();
-    this.onDataChangeEmitter = new Emitter();
-    this.variables$ = new Subject2();
-    // 监听变量列表中的单个变量变化
-    this.anyVariableChange$ = this.variables$.pipe(
-      switchMap2(
-        (_variables) => merge(
-          ..._variables.map(
-            (_v) => _v.value$.pipe(
-              // 跳过 BehaviorSubject 第一个
-              skip2(1)
-            )
-          )
-        )
-      ),
-      share2()
-    );
-    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 DisposableCollection3();
-    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) {
@@ -1544,7 +1562,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();
@@ -1553,6 +1571,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
     ]);
   }
@@ -1569,7 +1600,7 @@ var ScopeOutputData = class {
     return this.variableTable.onAnyVariableChange.bind(this.variableTable);
   }
   /**
-   * 作用域输出变量
+   * Scope Output Variable Declarations
    */
   get variables() {
     return this.memo(
@@ -1578,7 +1609,7 @@ var ScopeOutputData = class {
     );
   }
   /**
-   * 输出的变量 keys
+   * Output Variable Keys
    */
   get variableKeys() {
     return this.memo("variableKeys", () => this.variableTable.variableKeys);
@@ -1590,10 +1621,6 @@ var ScopeOutputData = class {
     this.variableTable.addVariableToTable(variable);
     this._hasChanges = true;
   }
-  // 标记为发生了变化，用于变量排序变化的场景
-  setHasChanges() {
-    this._hasChanges = true;
-  }
   removeVariableFromTable(key) {
     this.variableTable.removeVariableFromTable(key);
     this._hasChanges = true;
@@ -1601,7 +1628,9 @@ var ScopeOutputData = class {
   getVariableByKey(key) {
     return this.variableTable.getVariableByKey(key);
   }
-  // 通知覆盖作用域更新可用变量
+  /**
+   *
+   */
   notifyCoversChange() {
     this.scope.coverScopes.forEach((scope) => scope.available.refresh());
   }
@@ -1619,7 +1648,7 @@ import {
 } from "rxjs";
 import { flatten } from "lodash";
 import { shallowEqual as shallowEqual7 } from "fast-equals";
-import { Disposable as Disposable5 } from "@flowgram.ai/utils";
+import { Disposable as Disposable3 } from "@flowgram.ai/utils";
 import { Emitter as Emitter2 } from "@flowgram.ai/utils";
 var ScopeAvailableData = class {
   constructor(scope) {
@@ -1665,7 +1694,7 @@ var ScopeAvailableData = class {
       this.onAnyVariableChange(() => {
         this.onDataChangeEmitter.fire(this._variables);
       }),
-      Disposable5.create(() => {
+      Disposable3.create(() => {
         this.refresh$.complete();
         this.refresh$.unsubscribe();
       })
@@ -1772,7 +1801,7 @@ var Scope = class {
     this.ast = this.variableEngine.astRegisters.createAST(
       {
         kind: "MapNode" /* MapNode */,
-        key: this.id
+        key: String(this.id)
       },
       {
         scope: this
@@ -1825,7 +1854,7 @@ var VariableEngine = class {
     this.onScopeChange = this.onScopeChangeEmitter.event;
     this.toDispose.pushAll([
       chain,
-      Disposable6.create(() => {
+      Disposable4.create(() => {
         this.getAllScopes().forEach((scope) => scope.dispose());
         this.globalVariableTable.dispose();
       })
@@ -1845,11 +1874,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([
@@ -2053,7 +2089,6 @@ export {
   CustomType,
   DataNode,
   EnumerateExpression,
-  ExpressionList,
   IntegerType,
   KeyPathExpression,
   KeyPathExpressionV2,
@@ -2074,7 +2109,7 @@ export {
   VariableEngine,
   VariableEngineProvider,
   VariableFieldKeyRenameService,
-  VariableTable,
+  WrapArrayExpression,
   injectToAST,
   isMatchAST,
   postConstructAST,