@flowgram.ai/form-core 0.1.0-alpha.3 → 0.1.0-alpha.31

package/dist/index.d.mts

@@ -1,10 +1,15 @@
 import React from 'react';
 import { FlowNodeEntity } from '@flowgram.ai/document';
-import { EntityData, PlaygroundContext, EntityDataRegistry } from '@flowgram.ai/core';
+import * as _flowgram_ai_utils from '@flowgram.ai/utils';
+import { MaybePromise, Event, DisposableCollection, Emitter } from '@flowgram.ai/utils';
+import { EntityData, PlaygroundContext, PluginContext, EntityDataRegistry } from '@flowgram.ai/core';
 import * as inversify from 'inversify';
 import { ContainerModule } from 'inversify';
-import * as _flowgram_ai_utils from '@flowgram.ai/utils';
-import { Emitter, MaybePromise, Event, DisposableCollection } from '@flowgram.ai/utils';
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
 interface ErrorData {
     error: Error | null;
@@ -16,94 +21,42 @@ declare class FlowNodeErrorData extends EntityData {
     getError(): Error;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface NodeErrorRenderProps {
     error: Error;
     context: NodeContext;
 }
 type NodeErrorRender = Render<NodeErrorRenderProps>;
 
-declare const ErrorContainerModule: ContainerModule;
-
-declare function getNodeError(node: FlowNodeEntity): Error;
-
-interface NodeContext {
-    node: FlowNodeEntity;
-    playgroundContext: PlaygroundContext;
-}
-type Render<T = any> = (props: T) => any;
-type NodePluginRender = Render<NodeContext>;
-type NodePlaceholderRender = Render<NodeContext>;
-interface NodeRenderProps {
-    node: FlowNodeEntity;
-}
-type NodeRenderHoc = (Component: React.JSXElementConstructor<NodeRenderProps>) => React.JSXElementConstructor<NodeRenderProps>;
-
-declare enum MaterialRenderKey {
-    CustomNodeError = "Material_CustomNodeError"
-}
-declare class NodeManager {
-    readonly materialRenderRegistry: Map<string, Render>;
-    readonly pluginRenderRegistry: Map<string, Render>;
-    readonly nodeRenderHocs: NodeRenderHoc[];
-    protected nodeContributions: NodeContribution[];
-    registerMaterialRender(key: string, render: Render): void;
-    getMaterialRender(key: string): Render | undefined;
-    registerPluginRender(key: string, render: NodePluginRender): void;
-    getPluginRender(key: string): NodePluginRender | undefined;
-    registerNodeErrorRender(render: Render<NodeErrorRenderProps>): void;
-    get nodeRenderHoc(): (...args: any[]) => any;
-    registerNodeRenderHoc(hoc: NodeRenderHoc): void;
-    get nodeErrorRender(): Render | undefined;
-    protected init(): void;
-}
-
-declare const NodeContribution: unique symbol;
-interface NodeContribution {
-    onRegister?(nodeManager: NodeManager): void;
-}
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
-declare const NodeContainerModule: ContainerModule;
+declare const ErrorContainerModule: ContainerModule;
 
-declare const PLUGIN_KEY: {
-    FORM: string;
-    ERROR: string;
-};
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
-declare const MATERIAL_KEY: {
-    NODE_ERROR_RENDER: string;
-    NODE_PLACEHOLDER_RENDER: string;
-};
+declare function getNodeError(node: FlowNodeEntity): Error;
 
-interface INodeEngineContext {
-    readonly: boolean;
-}
 /**
- * NodeEngineContext 在 Node Engine 中为全局单例, 它的作用是让Node之间共享数据。
- * context 分为内置context(如 readonly) 和 自定义context(业务可以按需注入)
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
  */
-declare class NodeEngineContext {
-    static DEFAULT_READONLY: boolean;
-    static DEFAULT_JSON: {
-        readonly: boolean;
-    };
-    readonly onChangeEmitter: Emitter<NodeEngineContext>;
-    readonly onChange: _flowgram_ai_utils.Event<NodeEngineContext>;
-    private _readonly;
-    private _json;
-    get json(): INodeEngineContext;
-    get readonly(): boolean;
-    set readonly(value: boolean);
-    private fireChange;
-    private updateJSON;
-}
-
-declare class NodeEngine {
-    nodeManager: NodeManager;
-    context: NodeEngineContext;
-}
 
 declare const FormCoreContainerModule: ContainerModule;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface FormItemAbility {
     type: string;
     /**
@@ -116,6 +69,10 @@ interface AbilityClass {
     new (): FormItemAbility;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface IFormItem<T = any> {
     value: T;
 }
@@ -139,6 +96,11 @@ interface FormItemDomRef {
     current: HTMLElement | null;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FormItemAbilityMeta<Options = any> {
     type: string;
     options: Options;
@@ -190,6 +152,11 @@ interface FormItemHooks<T> {
     onValidate?: (params: FormItemHookParams & T) => void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FormDataTypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
 type FormDataType = string | number | boolean | FormDataObject | DataArray | null;
 interface FormDataObject {
@@ -247,7 +214,7 @@ interface IFormMeta {
     /**
      * 表单树结构root
      */
-    root: IFormItemMeta;
+    root?: IFormItemMeta;
     /**
      * 表单全局配置
      */
@@ -256,6 +223,7 @@ interface IFormMeta {
 interface NodeFormContext {
     node: FlowNodeEntity;
     playgroundContext: PlaygroundContext;
+    clientContext: PluginContext & Record<string, any>;
 }
 interface IFormMetaOptions {
     formatOnInit?: (value: any, context: NodeFormContext) => any;
@@ -270,6 +238,11 @@ interface FormMetaGeneratorParams<PlaygroundContext, FormValue = any> {
 type FormMetaGenerator<PlaygroundContext = any, FormValue = any> = (params: FormMetaGeneratorParams<FormValue, FormValue>) => MaybePromise<IFormMeta>;
 type FormMetaOrFormMetaGenerator = FormMetaGenerator | IFormMeta;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 type FormModelFactory = (entity: FlowNodeEntity) => FormModel;
 declare const FormModelFactory: unique symbol;
 declare const FormModelEntity: unique symbol;
@@ -288,9 +261,10 @@ declare abstract class FormModel {
      * @deprecated
      */
     abstract get formManager(): FormManager;
-    abstract get formMeta(): IFormMeta;
+    abstract get formMeta(): any;
     abstract get initialized(): boolean;
     abstract get valid(): FormModelValid;
+    abstract updateFormValues(value: any): void;
     /**
      * @deprecated
      * use `formModel.getFieldIn` instead in FormModelV2 to get the model of a form field
@@ -337,6 +311,11 @@ declare abstract class FormItem {
     dispose(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FormMetaTraverseParams {
     formItemMeta: IFormItemMeta;
     parentPath?: string;
@@ -354,6 +333,10 @@ declare class FormMeta implements IFormMeta {
     static traverse({ formItemMeta, parentPath, handle }: FormMetaTraverseParams): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface Extension {
     key: string;
 }
@@ -365,6 +348,11 @@ declare class FormAbilityExtensionRegistry {
     get collection(): Extension[];
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface FormItemMaterialContext {
     /**
      * 当前表单项的meta
@@ -405,16 +393,31 @@ interface FormItemMaterialContext {
     index?: number | undefined;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class SetterAbility implements FormItemAbility {
     static readonly type = "setter";
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class ValidationAbility implements FormItemAbility {
     static readonly type = "validation";
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface IValidateResult {
     type: 'error' | 'warning';
     message: string;
@@ -441,6 +444,11 @@ interface ValidationExtension {
     validator: ValidatorFunction;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface SetterAbilityOptions {
     /**
      * 已注册的setter的唯一标识
@@ -472,11 +480,21 @@ interface SetterExtension {
 }
 type SetterHoc = (Component: React.JSXElementConstructor<SetterComponentProps>) => React.JSXElementConstructor<SetterComponentProps>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class DecoratorAbility implements FormItemAbility {
     static readonly type = "decorator";
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface DecoratorAbilityOptions {
     /**
      * 已注册的decorator的唯一标识
@@ -494,6 +512,11 @@ interface DecoratorExtension {
     component: (props: DecoratorComponentProps) => any;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface VisibilityAbilityOptions {
     /**
      * 是否隐藏
@@ -509,11 +532,21 @@ declare class VisibilityAbility implements FormItemAbility {
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class EffectAbility implements FormItemAbility {
     static readonly type = "effect";
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface EffectAbilityOptions {
     /**
      * 已注册的effect 唯一标识
@@ -546,11 +579,21 @@ interface EffectExtension {
     effect: EffectFunction;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class DefaultAbility implements FormItemAbility {
     static readonly type = "default";
     get type(): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface GetDefaultValueProps extends FormItemContext {
     options: DefaultAbilityOptions;
     context: FormItemMaterialContext;
@@ -559,6 +602,10 @@ interface DefaultAbilityOptions<T = any> {
     getDefaultValue: (params: GetDefaultValueProps) => T;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare class FormPathService {
     static readonly ROOT = "/";
     static readonly DIVIDER = "/";
@@ -576,6 +623,11 @@ declare class FormPathService {
     simplify(path: string): string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare class FormContextMaker {
     readonly nodeEngineContext: NodeEngineContext;
     readonly playgroundContext: PlaygroundContext;
@@ -615,6 +667,11 @@ declare class FormManager {
     protected init(): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const FormContribution: unique symbol;
 interface FormContribution {
     onRegister?(formManager: FormManager): void;
@@ -653,6 +710,7 @@ declare class FlowNodeFormData extends EntityData {
     getFormModel<TFormModel>(): TFormModel;
     getDefaultData(): any;
     createForm(formMetaOrFormMetaGenerator: any, initialValue?: any): void;
+    updateFormValues(value: any): void;
     recreateForm(formMetaOrFormMetaGenerator: FormMetaOrFormMetaGenerator, initialValue?: any): void;
     toJSON(): any;
     dispose(): void;
@@ -663,22 +721,171 @@ declare class FlowNodeFormData extends EntityData {
     fireDetaiChange(detailChangeEvent: DetailChangeEvent): void;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function isNodeFormReady(node: FlowNodeEntity): boolean;
 declare function getFormModel(node: FlowNodeEntity): FormModel;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * @deprecated
+ * use `NodeFormContext` instead
+ */
+type NodeContext = NodeFormContext;
+type Render<T = any> = (props: T) => any;
+type NodePluginRender = Render<NodeFormContext>;
+type NodePlaceholderRender = Render<NodeFormContext>;
+interface NodeRenderProps {
+    node: FlowNodeEntity;
+}
+type NodeRenderHoc = (Component: React.JSXElementConstructor<NodeRenderProps>) => React.JSXElementConstructor<NodeRenderProps>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare enum MaterialRenderKey {
+    CustomNodeError = "Material_CustomNodeError"
+}
+declare class NodeManager {
+    readonly materialRenderRegistry: Map<string, Render>;
+    readonly pluginRenderRegistry: Map<string, Render>;
+    readonly nodeRenderHocs: NodeRenderHoc[];
+    protected nodeContributions: NodeContribution[];
+    registerMaterialRender(key: string, render: Render): void;
+    getMaterialRender(key: string): Render | undefined;
+    registerPluginRender(key: string, render: NodePluginRender): void;
+    getPluginRender(key: string): NodePluginRender | undefined;
+    registerNodeErrorRender(render: Render<NodeErrorRenderProps>): void;
+    get nodeRenderHoc(): (...args: any[]) => any;
+    registerNodeRenderHoc(hoc: NodeRenderHoc): void;
+    get nodeErrorRender(): Render | undefined;
+    protected init(): void;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const NodeContribution: unique symbol;
+interface NodeContribution {
+    onRegister?(nodeManager: NodeManager): void;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const NodeContainerModule: ContainerModule;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+declare const PLUGIN_KEY: {
+    FORM: string;
+    ERROR: string;
+};
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+declare const MATERIAL_KEY: {
+    NODE_ERROR_RENDER: string;
+    NODE_PLACEHOLDER_RENDER: string;
+};
+
+interface INodeEngineContext {
+    readonly: boolean;
+}
+/**
+ * NodeEngineContext 在 Node Engine 中为全局单例, 它的作用是让Node之间共享数据。
+ * context 分为内置context(如 readonly) 和 自定义context(业务可以按需注入)
+ */
+declare class NodeEngineContext {
+    static DEFAULT_READONLY: boolean;
+    static DEFAULT_JSON: {
+        readonly: boolean;
+    };
+    readonly onChangeEmitter: Emitter<NodeEngineContext>;
+    readonly onChange: _flowgram_ai_utils.Event<NodeEngineContext>;
+    private _readonly;
+    private _json;
+    get json(): INodeEngineContext;
+    get readonly(): boolean;
+    set readonly(value: boolean);
+    private fireChange;
+    private updateJSON;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare class NodeEngine {
+    nodeManager: NodeManager;
+    context: NodeEngineContext;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 declare function createNodeContainerModules(): inversify.ContainerModule[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const NodeRender: React.MemoExoticComponent<({ node }: NodeRenderProps) => React.JSX.Element>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function registerNodeErrorRender(nodeManager: NodeManager, render: Render): void;
 declare function registerNodePlaceholderRender(nodeManager: NodeManager, render: NodePlaceholderRender): void;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function createNodeEntityDatas(): EntityDataRegistry[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function useNodeEngineContext(): NodeEngineContext;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function useFormItem(path: string): IFormItem | undefined;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const NodeEngineReactContext: React.Context<INodeEngineContext>;
 
 export { type AbilityClass, type DataArray, DecoratorAbility, type DecoratorAbilityOptions, type DecoratorComponentProps, type DecoratorExtension, DefaultAbility, type DefaultAbilityOptions, type DetailChangeEvent, EffectAbility, type EffectAbilityOptions, type EffectEvent, type EffectExtension, type EffectFunction, type EffectProps, ErrorContainerModule, type ErrorData, type Extension, FORM_VOID, type FeedbackStatus, type FeedbackText, FlowNodeErrorData, FlowNodeFormData, FormAbilityExtensionRegistry, FormContextMaker, FormContribution, FormCoreContainerModule, type FormDataObject, type FormDataType, type FormDataTypeName, type FormFeedback, FormItem, type FormItemAbility, type FormItemAbilityMeta, type FormItemContext, type FormItemDomRef, FormItemEventName, type FormItemFeedback, type FormItemHookParams, type FormItemHooks, type FormItemMaterialContext, FormManager, FormMeta, type FormMetaGenerator, type FormMetaGeneratorParams, type FormMetaOrFormMetaGenerator, type FormMetaTraverseParams, FormModel, FormModelEntity, FormModelFactory, type FormModelValid, FormPathService, type GetDefaultValueProps, type IFormItem, type IFormItemMeta, type IFormMeta, type IFormMetaOptions, type INodeEngineContext, type IValidateResult, MATERIAL_KEY, MaterialRenderKey, NodeContainerModule, type NodeContext, NodeContribution, NodeEngine, NodeEngineContext, NodeEngineReactContext, type NodeErrorRender, type NodeErrorRenderProps, type NodeFormContext, NodeManager, type NodePlaceholderRender, type NodePluginRender, NodeRender, type NodeRenderHoc, type NodeRenderProps, type OnFormValuesChangePayload, PLUGIN_KEY, type Render, SetterAbility, type SetterAbilityOptions, type SetterComponentProps, type SetterExtension, type SetterHoc, type SetterOrDecoratorContext, type TreeNode, ValidationAbility, type ValidationAbilityOptions, type ValidationExtension, type ValidatorFunction, type ValidatorFunctionResponse, type ValidatorProps, VisibilityAbility, type VisibilityAbilityOptions, createNodeContainerModules, createNodeEntityDatas, getFormModel, getNodeError, isNodeFormReady, registerNodeErrorRender, registerNodePlaceholderRender, useFormItem, useNodeEngineContext };