@flowgram.ai/variable-core 0.5.6 → 1.0.0

package/dist/index.d.ts

@@ -358,9 +358,9 @@ declare abstract class ScopeChain {
     get onDispose(): Event<void>;
 }
 
-interface ASTNodeRegistry<JSON extends ASTNodeJSON = any, InjectOpts = any> {
+interface ASTNodeRegistry<JSON extends ASTNodeJSON = any> {
     kind: string;
-    new (params: CreateASTParams, injectOpts: InjectOpts): ASTNode<JSON>;
+    new (params: CreateASTParams, injectOpts: any): ASTNode<JSON>;
 }
 /**
  * An `ASTNode` represents a fundamental unit of variable information within the system's Abstract Syntax Tree.
@@ -375,14 +375,14 @@ interface ASTNodeRegistry<JSON extends ASTNodeJSON = any, InjectOpts = any> {
  * - **Reactive**: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.
  * - **Serializable**: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission.
  */
-declare abstract class ASTNode<JSON extends ASTNodeJSON = any, InjectOpts = any> implements Disposable {
+declare abstract class ASTNode<JSON extends ASTNodeJSON = any> implements Disposable {
     /**
      * @deprecated
      * Get the injected options for the ASTNode.
      *
      * Please use `@injectToAst(XXXService) declare xxxService: XXXService` to achieve external dependency injection.
      */
-    readonly opts?: InjectOpts;
+    readonly opts?: any;
     /**
      * The unique identifier of the ASTNode, which is **immutable**.
      * - Immutable: Once assigned, the key cannot be changed.
@@ -429,7 +429,7 @@ declare abstract class ASTNode<JSON extends ASTNodeJSON = any, InjectOpts = any>
     /**
      * Child ASTNodes.
      */
-    protected _children: Set<ASTNode<any, any>>;
+    protected _children: Set<ASTNode<any>>;
     /**
      * List of disposal handlers for the ASTNode.
      */
@@ -443,7 +443,7 @@ declare abstract class ASTNode<JSON extends ASTNodeJSON = any, InjectOpts = any>
      * @param createParams Necessary parameters for creating an ASTNode.
      * @param injectOptions Dependency injection for various modules.
      */
-    constructor({ key, parent, scope }: CreateASTParams, opts?: InjectOpts);
+    constructor({ key, parent, scope }: CreateASTParams, opts?: any);
     /**
      * The type of the ASTNode.
      */
@@ -461,7 +461,7 @@ declare abstract class ASTNode<JSON extends ASTNodeJSON = any, InjectOpts = any>
      * Serializes the current ASTNode to ASTNodeJSON.
      * @returns
      */
-    toJSON(): ASTNodeJSON;
+    abstract toJSON(): JSON;
     /**
      * Creates a child ASTNode.
      * @param json The AST JSON of the child ASTNode.
@@ -682,6 +682,9 @@ type DataInjector = () => Record<string, any>;
  * Register the AST node to the engine.
  */
 declare class ASTRegisters {
+    /**
+     * @deprecated Please use `@injectToAst(XXXService) declare xxxService: XXXService` to achieve external dependency injection.
+     */
     protected injectors: Map<ASTKindType, DataInjector>;
     protected astMap: Map<ASTKindType, ASTNodeRegistry>;
     /**
@@ -699,13 +702,16 @@ declare class ASTRegisters {
      * @param kind
      * @returns
      */
-    getASTRegistryByKind(kind: ASTKindType): ASTNodeRegistry<any, any> | undefined;
+    getASTRegistryByKind(kind: ASTKindType): ASTNodeRegistry<any> | undefined;
     /**
      * Registers an AST node.
      * @param ASTNode
-     * @param injector
      */
-    registerAST(ASTNode: ASTNodeRegistry, injector?: DataInjector): void;
+    registerAST(ASTNode: ASTNodeRegistry, 
+    /**
+     * @deprecated Please use `@injectToAst(XXXService) declare xxxService: XXXService` to achieve external dependency injection.
+     */
+    injector?: DataInjector): void;
 }
 
 /**
@@ -820,7 +826,10 @@ declare class ListNode extends ASTNode<ListNodeJSON> {
      * Serialize the `ListNode` to `ListNodeJSON`.
      * @returns The JSON representation of `ListNode`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        list: any[];
+    };
 }
 
 /**
@@ -852,7 +861,10 @@ declare class MapNode extends ASTNode<MapNodeJSON> {
      * Serialize the `MapNode` to `MapNodeJSON`.
      * @returns The JSON representation of `MapNode`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        map: [string, ASTNode<any>][];
+    };
     /**
      * Set a node in the map.
      * @param key The key of the node.
@@ -883,7 +895,7 @@ declare class MapNode extends ASTNode<MapNodeJSON> {
  *
  * All other types should extend this class.
  */
-declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any> extends ASTNode<JSON, InjectOpts> {
+declare abstract class BaseType<JSON extends ASTNodeJSON = any> extends ASTNode<JSON> {
     flags: number;
     /**
      * Check if the current type is equal to the target type.
@@ -899,11 +911,6 @@ declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any
      * @returns The variable field if found, otherwise `undefined`.
      */
     getByKeyPath(keyPath?: string[]): BaseVariableField | undefined;
-    /**
-     * Serialize the node to a JSON object.
-     * @returns The JSON representation of the node.
-     */
-    toJSON(): ASTNodeJSON;
 }
 
 /**
@@ -920,7 +927,7 @@ interface StringJSON {
      */
     format?: string;
 }
-declare class StringType extends BaseType {
+declare class StringType extends BaseType<StringJSON> {
     flags: ASTNodeFlags;
     static kind: string;
     protected _format?: string;
@@ -934,6 +941,13 @@ declare class StringType extends BaseType {
      * @param json StringJSON representation of the `StringType`.
      */
     fromJSON(json?: StringJSON): void;
+    /**
+     * Serialize the `StringType` to `StringJSON`.
+     * @returns The JSON representation of `StringType`.
+     */
+    toJSON(): {
+        format: string | undefined;
+    };
 }
 
 /**
@@ -952,6 +966,7 @@ declare class IntegerType extends BaseType {
      * @param json The `IntegerJSON` to deserialize.
      */
     fromJSON(): void;
+    toJSON(): {};
 }
 
 /**
@@ -969,6 +984,7 @@ declare class BooleanType extends BaseType {
      * @param json The `BooleanJSON` to deserialize.
      */
     fromJSON(): void;
+    toJSON(): {};
 }
 
 /**
@@ -986,6 +1002,7 @@ declare class NumberType extends BaseType {
      * @param json The `NumberJSON` to deserialize.
      */
     fromJSON(): void;
+    toJSON(): {};
 }
 
 /**
@@ -1043,7 +1060,10 @@ declare class ArrayType extends BaseType<ArrayJSON> {
      * Serialize the `ArrayType` to `ArrayJSON`
      * @returns The JSON representation of `ArrayType`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        items: any;
+    };
 }
 
 /**
@@ -1098,7 +1118,11 @@ declare class MapType extends BaseType<MapJSON> {
      * Serialize the node to a JSON object.
      * @returns The JSON representation of the node.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        keyType: any;
+        valueType: any;
+    };
 }
 
 /**
@@ -1109,9 +1133,7 @@ declare class MapType extends BaseType<MapJSON> {
 /**
  * ASTNodeJSON representation of the `Property`.
  */
-type PropertyJSON<VariableMeta = any> = BaseVariableFieldJSON<VariableMeta> & {
-    key: string;
-};
+type PropertyJSON<VariableMeta = any> = BaseVariableFieldJSON<VariableMeta>;
 /**
  * `Property` is a variable field that represents a property of a `ObjectType`.
  */
@@ -1119,11 +1141,6 @@ declare class Property<VariableMeta = any> extends BaseVariableField<VariableMet
     static kind: string;
 }
 
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
 /**
  * ASTNodeJSON representation of `ObjectType`
  */
@@ -1165,7 +1182,9 @@ declare class ObjectType extends BaseType<ObjectJSON> {
      * Serialize the `ObjectType` to `ObjectJSON`.
      * @returns The JSON representation of `ObjectType`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        properties: BaseVariableFieldJSON<any>[];
+    };
     /**
      * Get a variable field by key path.
      * @param keyPath The key path to search for.
@@ -1233,6 +1252,9 @@ declare class CustomType extends BaseType<CustomTypeJSON> {
      * @returns `true` if the types are equal, `false` otherwise.
      */
     isTypeEqual(targetTypeJSONOrKind?: ASTNodeJSONOrKind): boolean;
+    toJSON(): {
+        typeName: string;
+    };
 }
 
 /**
@@ -1246,7 +1268,7 @@ type ExpressionRefs = (BaseVariableField | undefined)[];
  *
  * All other expressions should extend this class.
  */
-declare abstract class BaseExpression<JSON extends ASTNodeJSON = any, InjectOpts = any> extends ASTNode<JSON, InjectOpts> {
+declare abstract class BaseExpression<JSON extends ASTNodeJSON = any> extends ASTNode<JSON> {
     flags: ASTNodeFlags;
     /**
      * Get the global variable table, which is used to access referenced variables.
@@ -1284,7 +1306,7 @@ declare abstract class BaseExpression<JSON extends ASTNodeJSON = any, InjectOpts
      * An observable that emits the referenced variable fields when they change.
      */
     refs$: Observable<ExpressionRefs>;
-    constructor(params: CreateASTParams, opts?: InjectOpts);
+    constructor(params: CreateASTParams, opts?: any);
 }
 
 /**
@@ -1310,7 +1332,7 @@ declare class EnumerateExpression extends BaseExpression<EnumerateExpressionJSON
     /**
      * The expression to be enumerated.
      */
-    get enumerateFor(): BaseExpression<any, any> | undefined;
+    get enumerateFor(): BaseExpression<any> | undefined;
     /**
      * The return type of the expression.
      */
@@ -1329,7 +1351,10 @@ declare class EnumerateExpression extends BaseExpression<EnumerateExpressionJSON
      * Serialize the `EnumerateExpression` to `EnumerateExpressionJSON`.
      * @returns The JSON representation of `EnumerateExpression`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        enumerateFor: any;
+    };
 }
 
 /**
@@ -1356,6 +1381,7 @@ interface KeyPathExpressionJSON$1 {
 declare class KeyPathExpression<CustomPathJSON extends ASTNodeJSON = KeyPathExpressionJSON$1> extends BaseExpression<CustomPathJSON> {
     static kind: string;
     protected _keyPath: string[];
+    protected _rawPathJson: CustomPathJSON;
     /**
      * The key path of the variable.
      */
@@ -1374,7 +1400,7 @@ declare class KeyPathExpression<CustomPathJSON extends ASTNodeJSON = KeyPathExpr
     /**
      * The return type of the expression.
      */
-    get returnType(): BaseType<any, any>;
+    get returnType(): BaseType<any>;
     /**
      * Parse the business-defined path expression into a key path.
      *
@@ -1394,13 +1420,12 @@ declare class KeyPathExpression<CustomPathJSON extends ASTNodeJSON = KeyPathExpr
      * @returns The JSON representation of the return type.
      */
     getReturnTypeJSONByRef(_ref: BaseVariableField | undefined): ASTNodeJSON | undefined;
-    protected prevRefTypeHash: string | undefined;
     constructor(params: CreateASTParams, opts: any);
     /**
      * Serialize the `KeyPathExpression` to `KeyPathExpressionJSON`.
      * @returns The JSON representation of `KeyPathExpression`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): CustomPathJSON;
 }
 
 /**
@@ -1424,6 +1449,7 @@ interface KeyPathExpressionJSON {
 declare class LegacyKeyPathExpression<CustomPathJSON extends ASTNodeJSON = KeyPathExpressionJSON> extends BaseExpression<CustomPathJSON> {
     static kind: string;
     protected _keyPath: string[];
+    protected _rawPathJson: CustomPathJSON;
     /**
      * The key path of the variable.
      */
@@ -1455,7 +1481,7 @@ declare class LegacyKeyPathExpression<CustomPathJSON extends ASTNodeJSON = KeyPa
      * Serialize the `KeyPathExpression` to `KeyPathExpressionJSON`.
      * @returns The JSON representation of `KeyPathExpression`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): CustomPathJSON;
 }
 
 /**
@@ -1482,7 +1508,7 @@ declare class WrapArrayExpression extends BaseExpression<WrapArrayExpressionJSON
     /**
      * The expression to be wrapped.
      */
-    get wrapFor(): BaseExpression<any, any> | undefined;
+    get wrapFor(): BaseExpression<any> | undefined;
     /**
      * The return type of the expression.
      */
@@ -1505,20 +1531,23 @@ declare class WrapArrayExpression extends BaseExpression<WrapArrayExpressionJSON
      * Serialize the `WrapArrayExpression` to `WrapArrayExpressionJSON`.
      * @returns The JSON representation of `WrapArrayExpression`.
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        wrapFor: any;
+    };
     protected init(): void;
 }
 
 /**
  * ASTNodeJSON representation of `BaseVariableField`
  */
-type BaseVariableFieldJSON<VariableMeta = any> = {
+interface BaseVariableFieldJSON<VariableMeta = any> extends ASTNodeJSON {
     /**
      * key of the variable field
      * - For `VariableDeclaration`, the key should be global unique.
      * - For `Property`, the key is the property name.
      */
-    key?: Identifier;
+    key: Identifier;
     /**
      * type of the variable field, similar to js code:
      * `const v: string`
@@ -1535,7 +1564,7 @@ type BaseVariableFieldJSON<VariableMeta = any> = {
      * meta data of the variable field, you cans store information like `title`, `icon`, etc.
      */
     meta?: VariableMeta;
-};
+}
 /**
  * Variable Field abstract class, which is the base class for `VariableDeclaration` and `Property`
  *
@@ -1579,7 +1608,7 @@ declare abstract class BaseVariableField<VariableMeta = any> extends ASTNode<Bas
      * Deserialize the `BaseVariableFieldJSON` to the `BaseVariableField`.
      * @param json ASTJSON representation of `BaseVariableField`
      */
-    fromJSON({ type, initializer, meta }: BaseVariableFieldJSON<VariableMeta>): void;
+    fromJSON({ type, initializer, meta }: Omit<BaseVariableFieldJSON<VariableMeta>, 'key'>): void;
     /**
      * Update the type of the variable field
      * @param type type ASTJSON representation of Type
@@ -1612,9 +1641,7 @@ declare abstract class BaseVariableField<VariableMeta = any> extends ASTNode<Bas
      * Serialize the variable field to JSON
      * @returns ASTNodeJSON representation of `BaseVariableField`
      */
-    toJSON(): BaseVariableFieldJSON<VariableMeta> & {
-        kind: string;
-    };
+    toJSON(): BaseVariableFieldJSON<VariableMeta>;
 }
 
 /**
@@ -1645,12 +1672,17 @@ declare class VariableDeclaration<VariableMeta = any> extends BaseVariableField<
     /**
      * Deserialize the `VariableDeclarationJSON` to the `VariableDeclaration`.
      */
-    fromJSON({ order, ...rest }: VariableDeclarationJSON<VariableMeta>): void;
+    fromJSON({ order, ...rest }: Omit<VariableDeclarationJSON<VariableMeta>, 'key'>): void;
     /**
      * Update the sorting order of the variable declaration.
      * @param order Variable sorting order. Default is 0.
      */
     updateOrder(order?: number): void;
+    /**
+     * Serialize the `VariableDeclaration` to `VariableDeclarationJSON`.
+     * @returns The JSON representation of `VariableDeclaration`.
+     */
+    toJSON(): VariableDeclarationJSON<VariableMeta>;
 }
 
 /**
@@ -1694,7 +1726,10 @@ declare class VariableDeclarationList extends ASTNode<VariableDeclarationListJSO
      * Serialize the `VariableDeclarationList` to the `VariableDeclarationListJSON`.
      * @returns ASTJSON representation of `VariableDeclarationList`
      */
-    toJSON(): ASTNodeJSON;
+    toJSON(): {
+        kind: ASTKind;
+        declarations: VariableDeclarationJSON<any>[];
+    };
 }
 
 /**
@@ -1772,12 +1807,12 @@ declare namespace ASTFactory {
      * Creates a `VariableDeclaration` node.
      */
     const createVariableDeclaration: <VariableMeta = any>(json: VariableDeclarationJSON<VariableMeta>) => {
-        key?: Identifier;
+        key: Identifier;
         type?: ASTNodeJSONOrKind;
         initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
+        kind: ASTKindType;
         order?: number;
-        kind: ASTKind;
     };
     /**
      * Creates a `Property` node.
@@ -1787,7 +1822,7 @@ declare namespace ASTFactory {
         type?: ASTNodeJSONOrKind;
         initializer?: ASTNodeJSON;
         meta?: VariableMeta | undefined;
-        kind: ASTKind;
+        kind: ASTKindType;
     };
     /**
      * Creates a `VariableDeclarationList` node.
@@ -2152,12 +2187,12 @@ declare const ScopeProvider: (props: React.PropsWithChildren<{
  * useCurrentScope returns the scope provided by ScopeProvider.
  * @returns
  */
-declare const useCurrentScope: (params?: {
+declare const useCurrentScope: <Strict extends boolean = false>(params?: {
     /**
      * whether to throw error when no scope in ScopeProvider is found
      */
-    strict?: boolean;
-}) => Scope;
+    strict: Strict;
+}) => Strict extends true ? Scope : Scope | undefined;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates