@flowgram.ai/variable-core 0.1.31 → 0.2.0

package/dist/index.d.mts

@@ -360,7 +360,7 @@ declare enum ASTKind {
      */
     KeyPathExpression = "KeyPathExpression",
     EnumerateExpression = "EnumerateExpression",
-    ExpressionList = "ExpressionList",
+    WrapArrayExpression = "WrapArrayExpression",
     /**
      * 通用 AST 节点
      */
@@ -494,10 +494,33 @@ declare class MapNode extends ASTNode<MapNodeJSON> {
     get(key: string): ASTNode | undefined;
 }
 
+declare namespace VarJSONSchema {
+    type BasicType = 'boolean' | 'string' | 'integer' | 'number' | 'object' | 'array' | 'map';
+    interface ISchema<T = string> {
+        type?: T;
+        default?: any;
+        title?: string;
+        description?: string;
+        enum?: (string | number)[];
+        properties?: Record<string, ISchema<T>>;
+        additionalProperties?: ISchema<T>;
+        items?: ISchema<T>;
+        required?: string[];
+        $ref?: string;
+        extra?: {
+            index?: number;
+            weak?: boolean;
+            formComponent?: string;
+            [key: string]: any;
+        };
+    }
+    type IBasicSchema = ISchema<BasicType>;
+}
+
 declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any> extends ASTNode<JSON, InjectOpts> {
     flags: number;
     /**
-     * 类型是否一致，节点有额外信息判断，请参考 extraTypeInfoEqual
+     * 类型是否一致
      * @param targetTypeJSON
      */
     isTypeEqual(targetTypeJSONOrKind?: ASTNodeJSONOrKind): boolean;
@@ -506,29 +529,46 @@ declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any
      * @param keyPath
      */
     getByKeyPath(keyPath?: string[]): BaseVariableField | undefined;
+    /**
+     * Get AST JSON for current base type
+     * @returns
+     */
     toJSON(): ASTNodeJSON;
+    /**
+     * Get Standard JSON Schema for current base type
+     * @returns
+     */
+    toJSONSchema(): VarJSONSchema.ISchema;
+    /**
+     * Check if the type is equal with json schema
+     */
+    isEqualWithJSONSchema(schema: VarJSONSchema.ISchema | VarJSONSchema.ISchema[]): boolean;
 }
 
 declare class StringType extends BaseType {
     flags: ASTNodeFlags;
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class IntegerType extends BaseType {
     flags: ASTNodeFlags;
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class BooleanType extends BaseType {
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class NumberType extends BaseType {
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 interface ArrayJSON {
@@ -568,6 +608,7 @@ declare class MapType extends BaseType<MapJSON> {
      */
     protected customStrongEqual(targetTypeJSON: ASTNodeJSON): boolean;
     toJSON(): ASTNodeJSON;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 type PropertyJSON<VariableMeta = any> = BaseVariableFieldJSON<VariableMeta> & {
@@ -607,6 +648,7 @@ declare class ObjectType extends BaseType<ObjectJSON> {
      * @returns
      */
     protected customStrongEqual(targetTypeJSON: ASTNodeJSON): boolean;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 interface UnionJSON {
@@ -622,6 +664,7 @@ declare class CustomType extends BaseType<CustomTypeJSON> {
     get typeName(): string;
     fromJSON(json: CustomTypeJSON): void;
     isTypeEqual(targetTypeJSONOrKind?: ASTNodeJSONOrKind): boolean;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 type ExpressionRefs = (BaseVariableField | undefined)[];
@@ -662,16 +705,6 @@ declare abstract class BaseExpression<JSON extends ASTNodeJSON = any, InjectOpts
     constructor(params: CreateASTParams, opts?: InjectOpts);
 }
 
-interface ExpressionListJSON {
-    expressions: ASTNodeJSON[];
-}
-declare class ExpressionList extends ASTNode<ExpressionListJSON> {
-    static kind: string;
-    expressions: ASTNode[];
-    fromJSON({ expressions }: ExpressionListJSON): void;
-    toJSON(): ASTNodeJSON;
-}
-
 interface KeyPathExpressionJSON$1 {
     keyPath: string[];
 }
@@ -738,6 +771,25 @@ declare class KeyPathExpressionV2<CustomPathJSON extends ASTNodeJSON = KeyPathEx
     toJSON(): ASTNodeJSON;
 }
 
+interface WrapArrayExpressionJSON {
+    wrapFor: ASTNodeJSON;
+}
+/**
+ * 遍历表达式，对列表进行遍历，获取遍历后的变量类型
+ */
+declare class WrapArrayExpression extends BaseExpression<WrapArrayExpressionJSON> {
+    static kind: string;
+    protected _wrapFor: BaseExpression | undefined;
+    protected _returnType: BaseType | undefined;
+    get wrapFor(): BaseExpression<any, any> | undefined;
+    get returnType(): BaseType | undefined;
+    refreshReturnType(): void;
+    getRefFields(): [];
+    fromJSON({ wrapFor: expression }: WrapArrayExpressionJSON): void;
+    toJSON(): ASTNodeJSON;
+    protected init(): void;
+}
+
 /**
  * 声明类 AST 节点
  */
@@ -897,6 +949,22 @@ declare namespace ASTFactory {
         keyPath: string[];
         kind: ASTKind;
     };
+    const createWrapArrayExpression: (json: WrapArrayExpressionJSON) => {
+        wrapFor: ASTNodeJSON;
+        kind: ASTKind;
+    };
+    /**
+     * Converts a JSON schema to an Abstract Syntax Tree (AST) representation.
+     * This function recursively processes the JSON schema and creates corresponding AST nodes.
+     *
+     * For more information on JSON Schema, refer to the official documentation:
+     * https://json-schema.org/
+     *
+     *
+     * @param jsonSchema - The JSON schema to convert.
+     * @returns An AST node representing the JSON schema, or undefined if the schema type is not recognized.
+     */
+    function createTypeASTFromSchema(jsonSchema: VarJSONSchema.ISchema): ASTNodeJSON | undefined;
     /**
      * 通过 AST Class 创建
      */
@@ -1044,4 +1112,4 @@ declare class VariableFieldKeyRenameService {
     dispose(): void;
 }
 
-export { ASTFactory, ASTKind, ASTMatch, ASTNode, ASTNodeFlags, type ASTNodeJSON, type ASTNodeRegistry, ASTRegisters, ArrayType, BaseExpression, BaseType, BaseVariableField, BooleanType, type CreateASTParams, CustomType, type CustomTypeJSON, DataNode, EnumerateExpression, type EnumerateExpressionJSON, ExpressionList, type ExpressionListJSON, type GetKindJSON, type GetKindJSONOrKind, type GlobalEventActionType, type IVariableTable, IntegerType, KeyPathExpression, type KeyPathExpressionJSON$1 as KeyPathExpressionJSON, KeyPathExpressionV2, ListNode, type ListNodeJSON, MapNode, type MapNodeJSON, MapType, NumberType, type ObjectJSON, type ObjectPropertiesChangeAction, ObjectType, Property, type PropertyJSON, Scope, ScopeChain, ScopeOutputData, ScopeProvider, StringType, type UnionJSON, VariableContainerModule, VariableDeclaration, type VariableDeclarationJSON, VariableDeclarationList, type VariableDeclarationListChangeAction, type VariableDeclarationListJSON, VariableEngine, VariableEngineProvider, VariableFieldKeyRenameService, injectToAST, isMatchAST, postConstructAST, useAvailableVariables, useCurrentScope, useScopeAvailable, useScopeContext };
+export { ASTFactory, ASTKind, ASTMatch, ASTNode, ASTNodeFlags, type ASTNodeJSON, type ASTNodeRegistry, ASTRegisters, ArrayType, BaseExpression, BaseType, BaseVariableField, BooleanType, type CreateASTParams, CustomType, type CustomTypeJSON, DataNode, EnumerateExpression, type EnumerateExpressionJSON, type GetKindJSON, type GetKindJSONOrKind, type GlobalEventActionType, type IVariableTable, IntegerType, KeyPathExpression, type KeyPathExpressionJSON$1 as KeyPathExpressionJSON, KeyPathExpressionV2, ListNode, type ListNodeJSON, MapNode, type MapNodeJSON, MapType, NumberType, type ObjectJSON, type ObjectPropertiesChangeAction, ObjectType, Property, type PropertyJSON, Scope, ScopeChain, ScopeOutputData, ScopeProvider, StringType, type UnionJSON, VarJSONSchema, VariableContainerModule, VariableDeclaration, type VariableDeclarationJSON, VariableDeclarationList, type VariableDeclarationListChangeAction, type VariableDeclarationListJSON, VariableEngine, VariableEngineProvider, VariableFieldKeyRenameService, WrapArrayExpression, type WrapArrayExpressionJSON, injectToAST, isMatchAST, postConstructAST, useAvailableVariables, useCurrentScope, useScopeAvailable, useScopeContext };

package/dist/index.d.ts

@@ -360,7 +360,7 @@ declare enum ASTKind {
      */
     KeyPathExpression = "KeyPathExpression",
     EnumerateExpression = "EnumerateExpression",
-    ExpressionList = "ExpressionList",
+    WrapArrayExpression = "WrapArrayExpression",
     /**
      * 通用 AST 节点
      */
@@ -494,10 +494,33 @@ declare class MapNode extends ASTNode<MapNodeJSON> {
     get(key: string): ASTNode | undefined;
 }
 
+declare namespace VarJSONSchema {
+    type BasicType = 'boolean' | 'string' | 'integer' | 'number' | 'object' | 'array' | 'map';
+    interface ISchema<T = string> {
+        type?: T;
+        default?: any;
+        title?: string;
+        description?: string;
+        enum?: (string | number)[];
+        properties?: Record<string, ISchema<T>>;
+        additionalProperties?: ISchema<T>;
+        items?: ISchema<T>;
+        required?: string[];
+        $ref?: string;
+        extra?: {
+            index?: number;
+            weak?: boolean;
+            formComponent?: string;
+            [key: string]: any;
+        };
+    }
+    type IBasicSchema = ISchema<BasicType>;
+}
+
 declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any> extends ASTNode<JSON, InjectOpts> {
     flags: number;
     /**
-     * 类型是否一致，节点有额外信息判断，请参考 extraTypeInfoEqual
+     * 类型是否一致
      * @param targetTypeJSON
      */
     isTypeEqual(targetTypeJSONOrKind?: ASTNodeJSONOrKind): boolean;
@@ -506,29 +529,46 @@ declare abstract class BaseType<JSON extends ASTNodeJSON = any, InjectOpts = any
      * @param keyPath
      */
     getByKeyPath(keyPath?: string[]): BaseVariableField | undefined;
+    /**
+     * Get AST JSON for current base type
+     * @returns
+     */
     toJSON(): ASTNodeJSON;
+    /**
+     * Get Standard JSON Schema for current base type
+     * @returns
+     */
+    toJSONSchema(): VarJSONSchema.ISchema;
+    /**
+     * Check if the type is equal with json schema
+     */
+    isEqualWithJSONSchema(schema: VarJSONSchema.ISchema | VarJSONSchema.ISchema[]): boolean;
 }
 
 declare class StringType extends BaseType {
     flags: ASTNodeFlags;
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class IntegerType extends BaseType {
     flags: ASTNodeFlags;
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class BooleanType extends BaseType {
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 declare class NumberType extends BaseType {
     static kind: string;
     fromJSON(): void;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 interface ArrayJSON {
@@ -568,6 +608,7 @@ declare class MapType extends BaseType<MapJSON> {
      */
     protected customStrongEqual(targetTypeJSON: ASTNodeJSON): boolean;
     toJSON(): ASTNodeJSON;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 type PropertyJSON<VariableMeta = any> = BaseVariableFieldJSON<VariableMeta> & {
@@ -607,6 +648,7 @@ declare class ObjectType extends BaseType<ObjectJSON> {
      * @returns
      */
     protected customStrongEqual(targetTypeJSON: ASTNodeJSON): boolean;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 interface UnionJSON {
@@ -622,6 +664,7 @@ declare class CustomType extends BaseType<CustomTypeJSON> {
     get typeName(): string;
     fromJSON(json: CustomTypeJSON): void;
     isTypeEqual(targetTypeJSONOrKind?: ASTNodeJSONOrKind): boolean;
+    toJSONSchema(): VarJSONSchema.ISchema;
 }
 
 type ExpressionRefs = (BaseVariableField | undefined)[];
@@ -662,16 +705,6 @@ declare abstract class BaseExpression<JSON extends ASTNodeJSON = any, InjectOpts
     constructor(params: CreateASTParams, opts?: InjectOpts);
 }
 
-interface ExpressionListJSON {
-    expressions: ASTNodeJSON[];
-}
-declare class ExpressionList extends ASTNode<ExpressionListJSON> {
-    static kind: string;
-    expressions: ASTNode[];
-    fromJSON({ expressions }: ExpressionListJSON): void;
-    toJSON(): ASTNodeJSON;
-}
-
 interface KeyPathExpressionJSON$1 {
     keyPath: string[];
 }
@@ -738,6 +771,25 @@ declare class KeyPathExpressionV2<CustomPathJSON extends ASTNodeJSON = KeyPathEx
     toJSON(): ASTNodeJSON;
 }
 
+interface WrapArrayExpressionJSON {
+    wrapFor: ASTNodeJSON;
+}
+/**
+ * 遍历表达式，对列表进行遍历，获取遍历后的变量类型
+ */
+declare class WrapArrayExpression extends BaseExpression<WrapArrayExpressionJSON> {
+    static kind: string;
+    protected _wrapFor: BaseExpression | undefined;
+    protected _returnType: BaseType | undefined;
+    get wrapFor(): BaseExpression<any, any> | undefined;
+    get returnType(): BaseType | undefined;
+    refreshReturnType(): void;
+    getRefFields(): [];
+    fromJSON({ wrapFor: expression }: WrapArrayExpressionJSON): void;
+    toJSON(): ASTNodeJSON;
+    protected init(): void;
+}
+
 /**
  * 声明类 AST 节点
  */
@@ -897,6 +949,22 @@ declare namespace ASTFactory {
         keyPath: string[];
         kind: ASTKind;
     };
+    const createWrapArrayExpression: (json: WrapArrayExpressionJSON) => {
+        wrapFor: ASTNodeJSON;
+        kind: ASTKind;
+    };
+    /**
+     * Converts a JSON schema to an Abstract Syntax Tree (AST) representation.
+     * This function recursively processes the JSON schema and creates corresponding AST nodes.
+     *
+     * For more information on JSON Schema, refer to the official documentation:
+     * https://json-schema.org/
+     *
+     *
+     * @param jsonSchema - The JSON schema to convert.
+     * @returns An AST node representing the JSON schema, or undefined if the schema type is not recognized.
+     */
+    function createTypeASTFromSchema(jsonSchema: VarJSONSchema.ISchema): ASTNodeJSON | undefined;
     /**
      * 通过 AST Class 创建
      */
@@ -1044,4 +1112,4 @@ declare class VariableFieldKeyRenameService {
     dispose(): void;
 }
 
-export { ASTFactory, ASTKind, ASTMatch, ASTNode, ASTNodeFlags, type ASTNodeJSON, type ASTNodeRegistry, ASTRegisters, ArrayType, BaseExpression, BaseType, BaseVariableField, BooleanType, type CreateASTParams, CustomType, type CustomTypeJSON, DataNode, EnumerateExpression, type EnumerateExpressionJSON, ExpressionList, type ExpressionListJSON, type GetKindJSON, type GetKindJSONOrKind, type GlobalEventActionType, type IVariableTable, IntegerType, KeyPathExpression, type KeyPathExpressionJSON$1 as KeyPathExpressionJSON, KeyPathExpressionV2, ListNode, type ListNodeJSON, MapNode, type MapNodeJSON, MapType, NumberType, type ObjectJSON, type ObjectPropertiesChangeAction, ObjectType, Property, type PropertyJSON, Scope, ScopeChain, ScopeOutputData, ScopeProvider, StringType, type UnionJSON, VariableContainerModule, VariableDeclaration, type VariableDeclarationJSON, VariableDeclarationList, type VariableDeclarationListChangeAction, type VariableDeclarationListJSON, VariableEngine, VariableEngineProvider, VariableFieldKeyRenameService, injectToAST, isMatchAST, postConstructAST, useAvailableVariables, useCurrentScope, useScopeAvailable, useScopeContext };
+export { ASTFactory, ASTKind, ASTMatch, ASTNode, ASTNodeFlags, type ASTNodeJSON, type ASTNodeRegistry, ASTRegisters, ArrayType, BaseExpression, BaseType, BaseVariableField, BooleanType, type CreateASTParams, CustomType, type CustomTypeJSON, DataNode, EnumerateExpression, type EnumerateExpressionJSON, type GetKindJSON, type GetKindJSONOrKind, type GlobalEventActionType, type IVariableTable, IntegerType, KeyPathExpression, type KeyPathExpressionJSON$1 as KeyPathExpressionJSON, KeyPathExpressionV2, ListNode, type ListNodeJSON, MapNode, type MapNodeJSON, MapType, NumberType, type ObjectJSON, type ObjectPropertiesChangeAction, ObjectType, Property, type PropertyJSON, Scope, ScopeChain, ScopeOutputData, ScopeProvider, StringType, type UnionJSON, VarJSONSchema, VariableContainerModule, VariableDeclaration, type VariableDeclarationJSON, VariableDeclarationList, type VariableDeclarationListChangeAction, type VariableDeclarationListJSON, VariableEngine, VariableEngineProvider, VariableFieldKeyRenameService, WrapArrayExpression, type WrapArrayExpressionJSON, injectToAST, isMatchAST, postConstructAST, useAvailableVariables, useCurrentScope, useScopeAvailable, useScopeContext };