@flowgram.ai/form-materials 0.1.0-alpha.11 → 0.1.0-alpha.12

package/dist/index.d.mts

@@ -1,43 +1,28 @@
 import React$1 from 'react';
+import { IJsonSchema, JsonSchemaTypeRegistry as JsonSchemaTypeRegistry$1, JsonSchemaTypeManager } from '@flowgram.ai/json-schema';
+export { IJsonSchema, JsonSchemaBasicType, JsonSchemaUtils } from '@flowgram.ai/json-schema';
 import { TriggerRenderProps } from '@douyinfe/semi-ui/lib/es/treeSelect';
 import { InferValues } from '@coze-editor/editor/react';
 import preset from '@coze-editor/editor/preset-code';
-import { EffectOptions, ASTNodeJSON, ASTNode, BaseType, FormPluginCreator } from '@flowgram.ai/editor';
+import { BaseVariableField, EffectOptions, EffectFuncProps, FormPluginCreator, FeedbackLevel, FlowNodeEntity } from '@flowgram.ai/editor';
+import * as _flowgram_ai_node from '@flowgram.ai/node';
+import * as _flowgram_ai_core from '@flowgram.ai/core';
 import { TreeNodeData } from '@douyinfe/semi-ui/lib/es/tree';
 
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-type JsonSchemaBasicType = 'boolean' | 'string' | 'integer' | 'number' | 'object' | 'array' | 'map';
-interface IJsonSchema<T = string> {
-    type?: T;
-    default?: any;
-    title?: string;
-    description?: string;
-    enum?: (string | number)[];
-    properties?: Record<string, IJsonSchema<T>>;
-    additionalProperties?: IJsonSchema<T>;
-    items?: IJsonSchema<T>;
-    required?: string[];
-    $ref?: string;
-    extra?: {
-        index?: number;
-        weak?: boolean;
-        formComponent?: string;
-        [key: string]: any;
-    };
-}
-type IBasicJsonSchema = IJsonSchema<JsonSchemaBasicType>;
-
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
  */
 
+type VariableField = BaseVariableField<{
+    icon?: string | JSX.Element;
+    title?: string;
+    disabled?: boolean;
+}>;
 declare function useVariableTree(params: {
     includeSchema?: IJsonSchema | IJsonSchema[];
     excludeSchema?: IJsonSchema | IJsonSchema[];
+    customSkip?: (variable: VariableField) => boolean;
 }): TreeNodeData[];
 
 /**
@@ -63,42 +48,6 @@ type VariableSelectorProps = PropTypes$2;
 
 declare const VariableSelector: ({ value, config, onChange, style, readonly, includeSchema, excludeSchema, hasError, triggerRender, }: PropTypes$2) => React$1.JSX.Element;
 
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-interface IFlowConstantValue {
-    type: 'constant';
-    content?: string | number | boolean;
-}
-interface IFlowRefValue {
-    type: 'ref';
-    content?: string[];
-}
-interface IFlowExpressionValue {
-    type: 'expression';
-    content?: string;
-}
-interface IFlowTemplateValue {
-    type: 'template';
-    content?: string;
-}
-type IFlowValue = IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue;
-type IFlowConstantRefValue = IFlowConstantValue | IFlowRefValue;
-
-/**
- * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
- * SPDX-License-Identifier: MIT
- */
-
-declare const VariableTypeIcons: {
-    [key: string]: React$1.ReactNode;
-};
-declare const ArrayIcons: {
-    [key: string]: React$1.ReactNode;
-};
-declare const getSchemaIcon: (value?: Partial<IJsonSchema>) => React$1.ReactNode;
-
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -106,7 +55,11 @@ declare const getSchemaIcon: (value?: Partial<IJsonSchema>) => React$1.ReactNode
 
 interface PropTypes$1 {
     value?: Partial<IJsonSchema>;
-    onChange: (value?: Partial<IJsonSchema>) => void;
+    onChange?: (value?: Partial<IJsonSchema>) => void;
+    readonly?: boolean;
+    /**
+     * @deprecated use readonly instead
+     */
     disabled?: boolean;
     style?: React$1.CSSProperties;
 }
@@ -139,6 +92,7 @@ declare function JsonSchemaEditor(props: {
     onChange?: (value: IJsonSchema) => void;
     config?: ConfigType;
     className?: string;
+    readonly?: boolean;
 }): React$1.JSX.Element;
 
 /**
@@ -153,18 +107,52 @@ declare function BatchVariableSelector(props: VariableSelectorProps): React$1.JS
  * SPDX-License-Identifier: MIT
  */
 
-interface Strategy<Value = any> {
-    hit: (schema: IJsonSchema) => boolean;
-    Renderer: React.FC<RendererProps<Value>>;
-}
-interface RendererProps<Value = any> {
+interface ConstantRendererProps<Value = any> {
     value?: Value;
     onChange?: (value: Value) => void;
     readonly?: boolean;
 }
-interface PropsType$4 extends RendererProps {
+interface JsonSchemaTypeRegistry<Value = any> extends JsonSchemaTypeRegistry$1 {
+    /**
+     * Render Constant Input
+     */
+    ConstantRenderer: React.FC<ConstantRendererProps<Value>>;
+}
+
+declare const createTypePresetPlugin: _flowgram_ai_core.PluginCreator<{
+    types?: Partial<JsonSchemaTypeRegistry> & Pick<JsonSchemaTypeRegistry, "type">[];
+    unregisterTypes?: string[];
+}>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const useTypeManager: () => JsonSchemaTypeManager<IJsonSchema, JsonSchemaTypeRegistry>;
+declare const JsonSchemaTypePresetProvider: ({ types, children, }: React$1.PropsWithChildren<{
+    types: JsonSchemaTypeRegistry[];
+}>) => React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+declare const createDisableDeclarationPlugin: _flowgram_ai_core.PluginCreator<void>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface Strategy<Value = any> {
+    hit: (schema: IJsonSchema) => boolean;
+    Renderer: React.FC<ConstantRendererProps<Value>>;
+}
+interface PropsType$a extends ConstantRendererProps {
     schema: IJsonSchema;
     strategies?: Strategy[];
+    fallbackRenderer?: React.FC<ConstantRendererProps>;
     [key: string]: any;
 }
 
@@ -173,14 +161,46 @@ interface PropsType$4 extends RendererProps {
  * SPDX-License-Identifier: MIT
  */
 
-declare function ConstantInput(props: PropsType$4): React$1.JSX.Element;
+declare function ConstantInput(props: PropsType$a): React$1.JSX.Element;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
  */
 
-interface PropsType$3 {
+interface IFlowValueExtra {
+    index?: number;
+}
+interface IFlowConstantValue {
+    type: 'constant';
+    content?: string | number | boolean;
+    schema?: IJsonSchema;
+    extra?: IFlowValueExtra;
+}
+interface IFlowRefValue {
+    type: 'ref';
+    content?: string[];
+    extra?: IFlowValueExtra;
+}
+interface IFlowExpressionValue {
+    type: 'expression';
+    content?: string;
+    extra?: IFlowValueExtra;
+}
+interface IFlowTemplateValue {
+    type: 'template';
+    content?: string;
+    extra?: IFlowValueExtra;
+}
+type IFlowValue = IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue;
+type IFlowConstantRefValue = IFlowConstantValue | IFlowRefValue;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$9 {
     value?: IFlowConstantRefValue;
     onChange: (value?: IFlowConstantRefValue) => void;
     readonly?: boolean;
@@ -193,7 +213,7 @@ interface PropsType$3 {
         [key: string]: any;
     };
 }
-declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType$3): React$1.JSX.Element;
+declare function DynamicValueInput({ value, onChange, readonly, style, schema: schemaFromProps, constantProps, }: PropsType$9): React$1.JSX.Element;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
@@ -241,7 +261,7 @@ declare function ConditionRow({ style, value, onChange, readonly }: PropTypes):
  */
 
 type ValueType = Record<string, IFlowRefValue | undefined>;
-interface PropsType$2 {
+interface PropsType$8 {
     value?: ValueType;
     onChange: (value?: ValueType) => void;
     readonly?: boolean;
@@ -254,14 +274,14 @@ interface PropsType$2 {
  * SPDX-License-Identifier: MIT
  */
 
-declare function BatchOutputs(props: PropsType$2): React$1.JSX.Element;
+declare function BatchOutputs(props: PropsType$8): React$1.JSX.Element;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
  */
 
-type PropsType$1 = React$1.PropsWithChildren<{
+type PropsType$7 = React$1.PropsWithChildren<{
     value?: IFlowTemplateValue;
     onChange: (value?: IFlowTemplateValue) => void;
     readonly?: boolean;
@@ -277,8 +297,8 @@ type PropsType$1 = React$1.PropsWithChildren<{
  * SPDX-License-Identifier: MIT
  */
 
-type PromptEditorPropsType = PropsType$1;
-declare function PromptEditor(props: PropsType$1): React$1.JSX.Element;
+type PromptEditorPropsType = PropsType$7;
+declare function PromptEditor(props: PropsType$7): React$1.JSX.Element;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
@@ -292,10 +312,10 @@ declare function PromptEditorWithVariables(props: PromptEditorPropsType): React$
  * SPDX-License-Identifier: MIT
  */
 
-interface PropsType extends PromptEditorPropsType {
+interface PropsType$6 extends PromptEditorPropsType {
     inputsValues: Record<string, IFlowValue>;
 }
-declare function PromptEditorWithInputs({ inputsValues, ...restProps }: PropsType): React$1.JSX.Element;
+declare function PromptEditorWithInputs({ inputsValues, ...restProps }: PropsType$6): React$1.JSX.Element;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
@@ -316,6 +336,13 @@ interface CodeEditorPropsType extends React$1.PropsWithChildren<{}> {
 }
 declare function CodeEditor({ value, onChange, languageId, theme, children, placeholder, activeLinePlaceholder, options, readonly, }: CodeEditorPropsType): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function CodeEditorMini(props: CodeEditorPropsType): React$1.JSX.Element;
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -328,14 +355,136 @@ declare function JsonEditorWithVariables(props: Omit<CodeEditorPropsType, 'langu
  * SPDX-License-Identifier: MIT
  */
 
-declare const provideBatchInputEffect: EffectOptions[];
+interface PropsType$5 {
+    value?: Record<string, IFlowValue | undefined>;
+    onChange: (value?: Record<string, IFlowValue | undefined>) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    schema?: IJsonSchema;
+    style?: React.CSSProperties;
+    constantProps?: {
+        strategies?: Strategy[];
+        [key: string]: any;
+    };
+}
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
  */
 
-declare const provideBatchOutputsEffect: EffectOptions[];
+declare function InputsValues({ value, onChange, style, readonly, constantProps, schema, hasError, }: PropsType$5): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$4 {
+    value?: IJsonSchema;
+    parentKey?: string;
+    depth?: number;
+    drilldown?: boolean;
+    showIcon?: boolean;
+    typeManager?: JsonSchemaTypeManager;
+}
+declare function DisplaySchemaTree(props: Omit<PropsType$4, 'parentKey' | 'depth'>): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$3 {
+    value?: IJsonSchema;
+    showIconInTree?: boolean;
+    displayFromScope?: boolean;
+    typeManager?: JsonSchemaTypeManager;
+}
+declare function DisplayOutputs({ value, showIconInTree, displayFromScope }: PropsType$3): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$2 {
+    title?: JSX.Element | string;
+    value?: IJsonSchema;
+    showIconInTree?: boolean;
+    warning?: boolean;
+}
+declare function DisplaySchemaTag({ value, showIconInTree, title, warning }: PropsType$2): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$1 {
+    value?: IFlowValue;
+    title?: JSX.Element | string;
+    showIconInTree?: boolean;
+    typeManager?: JsonSchemaTypeManager;
+}
+declare function DisplayFlowValue({ value, title, showIconInTree }: PropsType$1): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType {
+    value?: Record<string, IFlowValue | undefined>;
+    showIconInTree?: boolean;
+}
+declare function DisplayInputsValues({ value, showIconInTree }: PropsType): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface AssignRowsProps {
+    name: string;
+    readonly?: boolean;
+}
+declare function AssignRows(props: AssignRowsProps): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type AssignValueType = {
+    operator: 'assign';
+    left?: IFlowRefValue;
+    right?: IFlowValue;
+} | {
+    operator: 'declare';
+    left?: string;
+    right?: IFlowValue;
+};
+interface AssignRowProps {
+    value?: AssignValueType;
+    onChange?: (value?: AssignValueType) => void;
+    onDelete?: () => void;
+    readonly?: boolean;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function AssignRow(props: AssignRowProps): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const provideBatchInputEffect: EffectOptions[];
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
@@ -369,6 +518,58 @@ declare const provideJsonSchemaOutputs: EffectOptions[];
 
 declare const syncVariableTitle: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare const validateWhenVariableSync: ({ scope, }?: {
+    scope?: "private" | "public";
+}) => EffectOptions[];
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * Example:
+ * const formMeta = {
+ *   effect: {
+ *     'inputsValues.*': listenRefValueChange(({ name, variable, form }) => {
+ *       const schema = JsonSchemaUtils.astToSchema(variable?.type);
+ *       form.setValueIn(`${name}.schema`, schema);
+ *     })
+ *   }
+ * }
+ * @param cb
+ * @returns
+ */
+declare const listenRefValueChange: (cb: (props: EffectFuncProps<IFlowRefValue> & {
+    variable?: BaseVariableField;
+}) => void) => EffectOptions[];
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * Example:
+ * const formMeta = {
+ *   effect: {
+ *     'inputsValues.*': listenRefSchemaChange(({ name, schema, form }) => {
+ *       form.setValueIn(`${name}.schema`, schema);
+ *     })
+ *   }
+ * }
+ * @param cb
+ * @returns
+ */
+declare const listenRefSchemaChange: (cb: (props: EffectFuncProps<IFlowRefValue> & {
+    schema?: IJsonSchema;
+}) => void) => EffectOptions[];
+
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
@@ -458,45 +659,51 @@ declare function formatNewRefToLegacyRef(value: NewFlowRefValueSchema): {
  * SPDX-License-Identifier: MIT
  */
 
-declare namespace JsonSchemaUtils {
-    /**
-     * 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 schemaToAST(jsonSchema: IJsonSchema): ASTNodeJSON | undefined;
-    /**
-     * Convert AST To JSON Schema
-     * @param typeAST
-     * @returns
-     */
-    function astToSchema(typeAST: ASTNode, options?: {
-        drilldown?: boolean;
-    }): IJsonSchema | undefined;
-    /**
-     * Check if the AST type is match the JSON Schema
-     * @param typeAST
-     * @param schema
-     * @returns
-     */
-    function isASTMatchSchema(typeAST: BaseType, schema: IJsonSchema | IJsonSchema[]): boolean;
-}
+declare const provideBatchOutputsEffect: EffectOptions[];
+/**
+ * Free Layout only right now
+ */
+declare const createBatchOutputsFormPlugin: FormPluginCreator<{
+    outputKey: string;
+}>;
 
 /**
  * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
  * SPDX-License-Identifier: MIT
  */
+interface InputConfig$1 {
+    sourceKey: string;
+    targetKey: string;
+    scope?: 'private' | 'public';
+}
+declare const createInferInputsPlugin: _flowgram_ai_node.FormPluginCreator<InputConfig$1>;
 
 /**
- * Free Layout only right now
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
  */
-declare const createBatchOutputsFormPlugin: FormPluginCreator<{
+interface InputConfig {
+    assignKey: string;
     outputKey: string;
-}>;
+}
+declare const createInferAssignPlugin: _flowgram_ai_node.FormPluginCreator<InputConfig>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface Context {
+    node: FlowNodeEntity;
+    required?: boolean;
+    errorMessages?: {
+        required?: string;
+        unknownVariable?: string;
+    };
+}
+declare function validateFlowValue(value: IFlowValue | undefined, ctx: Context): {
+    level: FeedbackLevel;
+    message: string;
+} | undefined;
 
-export { ArrayIcons, BatchOutputs, BatchVariableSelector, CodeEditor, type CodeEditorPropsType, ConditionRow, type ConditionRowValueType, ConstantInput, DynamicValueInput, type IBasicJsonSchema, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IJsonSchema, JsonEditorWithVariables, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, PromptEditor, type PromptEditorPropsType, PromptEditorWithInputs, PromptEditorWithVariables, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, createBatchOutputsFormPlugin, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle, useVariableTree };
+export { AssignRow, AssignRows, type AssignValueType, BatchOutputs, BatchVariableSelector, CodeEditor, CodeEditorMini, type CodeEditorPropsType, ConditionRow, type ConditionRowValueType, ConstantInput, type ConstantRendererProps, DisplayFlowValue, DisplayInputsValues, DisplayOutputs, DisplaySchemaTag, DisplaySchemaTree, DynamicValueInput, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IFlowValueExtra, InputsValues, JsonEditorWithVariables, JsonSchemaEditor, JsonSchemaTypePresetProvider, type JsonSchemaTypeRegistry, PromptEditor, type PromptEditorPropsType, PromptEditorWithInputs, PromptEditorWithVariables, TypeSelector, VariableSelector, type VariableSelectorProps, autoRenameRefEffect, createBatchOutputsFormPlugin, createDisableDeclarationPlugin, createInferAssignPlugin, createInferInputsPlugin, createTypePresetPlugin, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, listenRefSchemaChange, listenRefValueChange, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle, useTypeManager, useVariableTree, validateFlowValue, validateWhenVariableSync };