@flowgram.ai/variable-core 0.2.27 → 0.2.29

package/dist/index.d.mts

@@ -28,7 +28,7 @@ declare class ScopeOutputData {
     protected variableTable: IVariableTable;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     get variableEngine(): VariableEngine;
     get globalVariableTable(): IVariableTable;
@@ -39,11 +39,11 @@ declare class ScopeOutputData {
     /**
      * listen to variable list change
      */
-    get onVariableListChange(): (observer: (variables: VariableDeclaration<any>[]) => void) => _flowgram_ai_utils.Disposable;
+    get onVariableListChange(): (observer: (variables: VariableDeclaration[]) => void) => _flowgram_ai_utils.Disposable;
     /**
      * listen to any variable update in list
      */
-    get onAnyVariableChange(): (observer: (changedVariable: VariableDeclaration<any>) => void) => _flowgram_ai_utils.Disposable;
+    get onAnyVariableChange(): (observer: (changedVariable: VariableDeclaration) => void) => _flowgram_ai_utils.Disposable;
     /**
      * listen to variable list change + any variable update in list
      */
@@ -74,7 +74,7 @@ declare class ScopeAvailableData {
     readonly scope: Scope;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     get globalVariableTable(): IVariableTable;
     protected refresh$: Subject<void>;
@@ -195,7 +195,7 @@ declare class Scope<ScopeMeta extends Record<string, any> = Record<string, any>>
      */
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     toDispose: DisposableCollection;
     constructor(options: {
@@ -417,33 +417,33 @@ declare enum ASTKind {
      * 类型相关
      * - 内部默认实现一套基于 JSON 类型的类型 AST 节点
      */
-    String = "String",
-    Number = "Number",
-    Integer = "Integer",
-    Boolean = "Boolean",
-    Object = "Object",
-    Array = "Array",
-    Map = "Map",
-    Union = "Union",
-    Any = "Any",
-    CustomType = "CustomType",
+    String = "String",// 字符串
+    Number = "Number",// 数字
+    Integer = "Integer",// 整数
+    Boolean = "Boolean",// 布尔值
+    Object = "Object",// Object
+    Array = "Array",// Array
+    Map = "Map",// Map
+    Union = "Union",// 联合类型，常用于类型判断，一般不对业务透出
+    Any = "Any",// 任意类型，常用于业务判断
+    CustomType = "CustomType",// 自定义类型，用于业务自定义类型
     /**
      * 声明
      */
-    Property = "Property",
-    VariableDeclaration = "VariableDeclaration",
-    VariableDeclarationList = "VariableDeclarationList",
+    Property = "Property",// Object 下钻的字段定义
+    VariableDeclaration = "VariableDeclaration",// 变量声明
+    VariableDeclarationList = "VariableDeclarationList",// 变量声明
     /**
      * 表达式
      */
-    KeyPathExpression = "KeyPathExpression",
-    EnumerateExpression = "EnumerateExpression",
-    WrapArrayExpression = "WrapArrayExpression",
+    KeyPathExpression = "KeyPathExpression",// 通过路径系统访问变量上的字段
+    EnumerateExpression = "EnumerateExpression",// 对指定的数据进行遍历
+    WrapArrayExpression = "WrapArrayExpression",// Wrap with Array Type
     /**
      * 通用 AST 节点
      */
-    ListNode = "ListNode",
-    DataNode = "DataNode",
+    ListNode = "ListNode",// 通用 List<ASTNode> 存储节点
+    DataNode = "DataNode",// 通用的数据存储节点
     MapNode = "MapNode"
 }
 interface CreateASTParams {
@@ -522,10 +522,10 @@ declare enum ASTNodeFlags {
     /**
      * 变量类型
      */
-    BasicType = 8,
-    DrilldownType = 16,
-    EnumerateType = 32,
-    UnionType = 64,
+    BasicType = 8,// 基础类型
+    DrilldownType = 16,// 可下钻的变量类型
+    EnumerateType = 32,// 可遍历的变量类型
+    UnionType = 64,// 复合类型，暂时不存在
     VariableType = 120
 }
 
@@ -1049,16 +1049,16 @@ declare namespace ASTFactory {
         kind: ASTKind;
     };
     const createArray: (json: ArrayJSON) => {
-        items?: ASTNodeJSONOrKind | undefined;
+        items?: ASTNodeJSONOrKind;
         kind: ASTKind;
     };
     const createMap: (json: MapJSON) => {
-        keyType?: ASTNodeJSONOrKind | undefined;
-        valueType?: ASTNodeJSONOrKind | undefined;
+        keyType?: ASTNodeJSONOrKind;
+        valueType?: ASTNodeJSONOrKind;
         kind: ASTKind;
     };
     const createUnion: (json: UnionJSON) => {
-        types?: ASTNodeJSONOrKind[] | undefined;
+        types?: ASTNodeJSONOrKind[];
         kind: ASTKind;
     };
     const createCustomType: (json: CustomTypeJSON) => {
@@ -1069,23 +1069,23 @@ declare namespace ASTFactory {
      * 声明相关
      */
     const createVariableDeclaration: <VariableMeta = any>(json: VariableDeclarationJSON<VariableMeta>) => {
-        key?: string | undefined;
-        type?: ASTNodeJSONOrKind | undefined;
-        initializer?: ASTNodeJSON | undefined;
+        key?: Identifier;
+        type?: ASTNodeJSONOrKind;
+        initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
-        order?: number | undefined;
+        order?: number;
         kind: ASTKind;
     };
     const createProperty: <VariableMeta = any>(json: PropertyJSON<VariableMeta>) => {
-        key: string;
-        type?: ASTNodeJSONOrKind | undefined;
-        initializer?: ASTNodeJSON | undefined;
+        key: Identifier;
+        type?: ASTNodeJSONOrKind;
+        initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
         kind: ASTKind;
     };
     const createVariableDeclarationList: (json: VariableDeclarationListJSON) => {
         declarations?: VariableDeclarationJSON<any>[] | undefined;
-        startOrder?: number | undefined;
+        startOrder?: number;
         kind: ASTKind;
     };
     /**
@@ -1106,14 +1106,19 @@ declare namespace ASTFactory {
     /**
      * 通过 AST Class 创建
      */
-    const create: <JSON_1 extends ASTNodeJSON>(targetType: {
-        new (...args: any[]): ASTNode<JSON_1, any>;
+    const create: <JSON extends ASTNodeJSON>(targetType: {
         kind: string;
-    }, json: JSON_1) => {
+        new (...args: any[]): ASTNode<JSON>;
+    }, json: JSON) => {
         kind: string;
-    } & JSON_1;
+    } & JSON;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare namespace ASTMatch {
     /**
      * 类型相关
@@ -1137,7 +1142,7 @@ declare namespace ASTMatch {
      * 表达式相关
      */
     const isEnumerateExpression: (node?: ASTNode) => node is EnumerateExpression;
-    const isKeyPathExpression: (node?: ASTNode) => node is KeyPathExpression<KeyPathExpressionJSON$1>;
+    const isKeyPathExpression: (node?: ASTNode) => node is KeyPathExpression;
     /**
      * Check AST Match by ASTClass
      */
@@ -1201,7 +1206,7 @@ declare class VariableEngine implements Disposable {
     protected toDispose: DisposableCollection;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     protected scopeMap: Map<string | symbol, Scope<Record<string, any>>>;
     globalEvent$: Subject<GlobalEventActionType>;

package/dist/index.d.ts

@@ -28,7 +28,7 @@ declare class ScopeOutputData {
     protected variableTable: IVariableTable;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     get variableEngine(): VariableEngine;
     get globalVariableTable(): IVariableTable;
@@ -39,11 +39,11 @@ declare class ScopeOutputData {
     /**
      * listen to variable list change
      */
-    get onVariableListChange(): (observer: (variables: VariableDeclaration<any>[]) => void) => _flowgram_ai_utils.Disposable;
+    get onVariableListChange(): (observer: (variables: VariableDeclaration[]) => void) => _flowgram_ai_utils.Disposable;
     /**
      * listen to any variable update in list
      */
-    get onAnyVariableChange(): (observer: (changedVariable: VariableDeclaration<any>) => void) => _flowgram_ai_utils.Disposable;
+    get onAnyVariableChange(): (observer: (changedVariable: VariableDeclaration) => void) => _flowgram_ai_utils.Disposable;
     /**
      * listen to variable list change + any variable update in list
      */
@@ -74,7 +74,7 @@ declare class ScopeAvailableData {
     readonly scope: Scope;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     get globalVariableTable(): IVariableTable;
     protected refresh$: Subject<void>;
@@ -195,7 +195,7 @@ declare class Scope<ScopeMeta extends Record<string, any> = Record<string, any>>
      */
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     toDispose: DisposableCollection;
     constructor(options: {
@@ -417,33 +417,33 @@ declare enum ASTKind {
      * 类型相关
      * - 内部默认实现一套基于 JSON 类型的类型 AST 节点
      */
-    String = "String",
-    Number = "Number",
-    Integer = "Integer",
-    Boolean = "Boolean",
-    Object = "Object",
-    Array = "Array",
-    Map = "Map",
-    Union = "Union",
-    Any = "Any",
-    CustomType = "CustomType",
+    String = "String",// 字符串
+    Number = "Number",// 数字
+    Integer = "Integer",// 整数
+    Boolean = "Boolean",// 布尔值
+    Object = "Object",// Object
+    Array = "Array",// Array
+    Map = "Map",// Map
+    Union = "Union",// 联合类型，常用于类型判断，一般不对业务透出
+    Any = "Any",// 任意类型，常用于业务判断
+    CustomType = "CustomType",// 自定义类型，用于业务自定义类型
     /**
      * 声明
      */
-    Property = "Property",
-    VariableDeclaration = "VariableDeclaration",
-    VariableDeclarationList = "VariableDeclarationList",
+    Property = "Property",// Object 下钻的字段定义
+    VariableDeclaration = "VariableDeclaration",// 变量声明
+    VariableDeclarationList = "VariableDeclarationList",// 变量声明
     /**
      * 表达式
      */
-    KeyPathExpression = "KeyPathExpression",
-    EnumerateExpression = "EnumerateExpression",
-    WrapArrayExpression = "WrapArrayExpression",
+    KeyPathExpression = "KeyPathExpression",// 通过路径系统访问变量上的字段
+    EnumerateExpression = "EnumerateExpression",// 对指定的数据进行遍历
+    WrapArrayExpression = "WrapArrayExpression",// Wrap with Array Type
     /**
      * 通用 AST 节点
      */
-    ListNode = "ListNode",
-    DataNode = "DataNode",
+    ListNode = "ListNode",// 通用 List<ASTNode> 存储节点
+    DataNode = "DataNode",// 通用的数据存储节点
     MapNode = "MapNode"
 }
 interface CreateASTParams {
@@ -522,10 +522,10 @@ declare enum ASTNodeFlags {
     /**
      * 变量类型
      */
-    BasicType = 8,
-    DrilldownType = 16,
-    EnumerateType = 32,
-    UnionType = 64,
+    BasicType = 8,// 基础类型
+    DrilldownType = 16,// 可下钻的变量类型
+    EnumerateType = 32,// 可遍历的变量类型
+    UnionType = 64,// 复合类型，暂时不存在
     VariableType = 120
 }
 
@@ -1049,16 +1049,16 @@ declare namespace ASTFactory {
         kind: ASTKind;
     };
     const createArray: (json: ArrayJSON) => {
-        items?: ASTNodeJSONOrKind | undefined;
+        items?: ASTNodeJSONOrKind;
         kind: ASTKind;
     };
     const createMap: (json: MapJSON) => {
-        keyType?: ASTNodeJSONOrKind | undefined;
-        valueType?: ASTNodeJSONOrKind | undefined;
+        keyType?: ASTNodeJSONOrKind;
+        valueType?: ASTNodeJSONOrKind;
         kind: ASTKind;
     };
     const createUnion: (json: UnionJSON) => {
-        types?: ASTNodeJSONOrKind[] | undefined;
+        types?: ASTNodeJSONOrKind[];
         kind: ASTKind;
     };
     const createCustomType: (json: CustomTypeJSON) => {
@@ -1069,23 +1069,23 @@ declare namespace ASTFactory {
      * 声明相关
      */
     const createVariableDeclaration: <VariableMeta = any>(json: VariableDeclarationJSON<VariableMeta>) => {
-        key?: string | undefined;
-        type?: ASTNodeJSONOrKind | undefined;
-        initializer?: ASTNodeJSON | undefined;
+        key?: Identifier;
+        type?: ASTNodeJSONOrKind;
+        initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
-        order?: number | undefined;
+        order?: number;
         kind: ASTKind;
     };
     const createProperty: <VariableMeta = any>(json: PropertyJSON<VariableMeta>) => {
-        key: string;
-        type?: ASTNodeJSONOrKind | undefined;
-        initializer?: ASTNodeJSON | undefined;
+        key: Identifier;
+        type?: ASTNodeJSONOrKind;
+        initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
         kind: ASTKind;
     };
     const createVariableDeclarationList: (json: VariableDeclarationListJSON) => {
         declarations?: VariableDeclarationJSON<any>[] | undefined;
-        startOrder?: number | undefined;
+        startOrder?: number;
         kind: ASTKind;
     };
     /**
@@ -1106,14 +1106,19 @@ declare namespace ASTFactory {
     /**
      * 通过 AST Class 创建
      */
-    const create: <JSON_1 extends ASTNodeJSON>(targetType: {
-        new (...args: any[]): ASTNode<JSON_1, any>;
+    const create: <JSON extends ASTNodeJSON>(targetType: {
         kind: string;
-    }, json: JSON_1) => {
+        new (...args: any[]): ASTNode<JSON>;
+    }, json: JSON) => {
         kind: string;
-    } & JSON_1;
+    } & JSON;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare namespace ASTMatch {
     /**
      * 类型相关
@@ -1137,7 +1142,7 @@ declare namespace ASTMatch {
      * 表达式相关
      */
     const isEnumerateExpression: (node?: ASTNode) => node is EnumerateExpression;
-    const isKeyPathExpression: (node?: ASTNode) => node is KeyPathExpression<KeyPathExpressionJSON$1>;
+    const isKeyPathExpression: (node?: ASTNode) => node is KeyPathExpression;
     /**
      * Check AST Match by ASTClass
      */
@@ -1201,7 +1206,7 @@ declare class VariableEngine implements Disposable {
     protected toDispose: DisposableCollection;
     protected memo: {
         <T>(key: string | symbol, fn: () => T): T;
-        clear: (key?: (string | symbol) | undefined) => void;
+        clear: (key?: string | symbol) => void;
     };
     protected scopeMap: Map<string | symbol, Scope<Record<string, any>>>;
     globalEvent$: Subject<GlobalEventActionType>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowgram.ai/variable-core",
-  "version": "0.2.27",
+  "version": "0.2.29",
   "description": "variable engine based on scope",
   "keywords": [
     "flow",
@@ -29,8 +29,8 @@
     "nanoid": "^4.0.2",
     "reflect-metadata": "~0.2.2",
     "rxjs": "^7.8.1",
-    "@flowgram.ai/core": "0.2.27",
-    "@flowgram.ai/utils": "0.2.27"
+    "@flowgram.ai/core": "0.2.29",
+    "@flowgram.ai/utils": "0.2.29"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.137",
@@ -39,10 +39,10 @@
     "@vitest/coverage-v8": "^0.32.0",
     "eslint": "^8.54.0",
     "tsup": "^8.0.1",
-    "typescript": "^5.0.4",
+    "typescript": "^5.8.3",
     "vitest": "^0.34.6",
-    "@flowgram.ai/eslint-config": "0.2.27",
-    "@flowgram.ai/ts-config": "0.2.27"
+    "@flowgram.ai/ts-config": "0.2.29",
+    "@flowgram.ai/eslint-config": "0.2.29"
   },
   "peerDependencies": {
     "react": ">=16.8",