@flowgram.ai/form-materials 0.2.16 → 0.2.17

package/dist/index.d.mts

@@ -1,7 +1,12 @@
 import React$1 from 'react';
 import { TriggerRenderProps } from '@douyinfe/semi-ui/lib/es/treeSelect';
-import { EffectOptions, ASTNodeJSON, ASTNode, BaseType } from '@flowgram.ai/editor';
+import { EffectOptions, ASTNodeJSON, ASTNode, BaseType, FormPluginCreator } from '@flowgram.ai/editor';
+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;
@@ -23,6 +28,21 @@ interface IJsonSchema<T = string> {
 }
 type IBasicJsonSchema = IJsonSchema<JsonSchemaBasicType>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function useVariableTree(params: {
+    includeSchema?: IJsonSchema | IJsonSchema[];
+    excludeSchema?: IJsonSchema | IJsonSchema[];
+}): TreeNodeData[];
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes$2 {
     value?: string[];
     config?: {
@@ -38,8 +58,13 @@ interface PropTypes$2 {
     triggerRender?: (props: TriggerRenderProps) => React$1.ReactNode;
 }
 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;
@@ -59,6 +84,11 @@ interface IFlowTemplateValue {
 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;
 };
@@ -67,6 +97,11 @@ declare const ArrayIcons: {
 };
 declare const getSchemaIcon: (value?: Partial<IJsonSchema>) => React$1.ReactNode;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes$1 {
     value?: Partial<IJsonSchema>;
     onChange: (value?: Partial<IJsonSchema>) => void;
@@ -77,6 +112,11 @@ declare const getTypeSelectValue: (value?: Partial<IJsonSchema>) => string[] | u
 declare const parseTypeSelectValue: (value?: string[]) => Partial<IJsonSchema> | undefined;
 declare function TypeSelector(props: PropTypes$1): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface ConfigType {
     placeholder?: string;
     descTitle?: string;
@@ -87,6 +127,11 @@ interface ConfigType {
     jsonFormatText?: string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function JsonSchemaEditor(props: {
     value?: IJsonSchema;
     onChange?: (value: IJsonSchema) => void;
@@ -94,8 +139,18 @@ declare function JsonSchemaEditor(props: {
     className?: string;
 }): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function BatchVariableSelector(props: VariableSelectorProps): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface Strategy<Value = any> {
     hit: (schema: IJsonSchema) => boolean;
     Renderer: React.FC<RendererProps<Value>>;
@@ -105,15 +160,25 @@ interface RendererProps<Value = any> {
     onChange?: (value: Value) => void;
     readonly?: boolean;
 }
-interface PropsType$1 extends RendererProps {
+interface PropsType$2 extends RendererProps {
     schema: IJsonSchema;
     strategies?: Strategy[];
     [key: string]: any;
 }
 
-declare function ConstantInput(props: PropsType$1): React$1.JSX.Element;
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
-interface PropsType {
+declare function ConstantInput(props: PropsType$2): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$1 {
     value?: IFlowConstantRefValue;
     onChange: (value?: IFlowConstantRefValue) => void;
     readonly?: boolean;
@@ -122,10 +187,16 @@ interface PropsType {
     schema?: IJsonSchema;
     constantProps?: {
         strategies?: Strategy[];
+        schema?: IJsonSchema;
         [key: string]: any;
     };
 }
-declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType): React$1.JSX.Element;
+declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType$1): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
 declare enum Op {
     EQ = "eq",
@@ -149,6 +220,11 @@ interface ConditionRowValueType {
     right?: IFlowConstantRefValue;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes {
     value?: ConditionRowValueType;
     onChange: (value?: ConditionRowValueType) => void;
@@ -157,10 +233,46 @@ interface PropTypes {
 }
 declare function ConditionRow({ style, value, onChange, readonly }: PropTypes): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type ValueType = Record<string, IFlowRefValue | undefined>;
+interface PropsType {
+    value?: ValueType;
+    onChange: (value?: ValueType) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    style?: React.CSSProperties;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function BatchOutputs(props: PropsType): 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
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const provideBatchOutputsEffect: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Auto rename ref when form item's key is renamed
  *
@@ -174,10 +286,24 @@ declare const provideBatchOutputsEffect: EffectOptions[];
  */
 declare const autoRenameRefEffect: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const provideJsonSchemaOutputs: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const syncVariableTitle: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface LegacyFlowRefValueSchema {
     type: 'ref';
     content: string;
@@ -258,6 +384,11 @@ declare function formatNewRefToLegacyRef(value: NewFlowRefValueSchema): {
     content: string;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare namespace JsonSchemaUtils {
     /**
      * Converts a JSON schema to an Abstract Syntax Tree (AST) representation.
@@ -287,4 +418,16 @@ declare namespace JsonSchemaUtils {
     function isASTMatchSchema(typeAST: BaseType, schema: IJsonSchema | IJsonSchema[]): boolean;
 }
 
-export { ArrayIcons, BatchVariableSelector, ConditionRow, type ConditionRowValueType, ConstantInput, DynamicValueInput, type IBasicJsonSchema, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IJsonSchema, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle };
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * Free Layout only right now
+ */
+declare const createBatchOutputsFormPlugin: FormPluginCreator<{
+    outputKey: string;
+}>;
+
+export { ArrayIcons, BatchOutputs, BatchVariableSelector, ConditionRow, type ConditionRowValueType, ConstantInput, DynamicValueInput, type IBasicJsonSchema, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IJsonSchema, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, createBatchOutputsFormPlugin, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle, useVariableTree };

package/dist/index.d.ts

@@ -1,7 +1,12 @@
 import React$1 from 'react';
 import { TriggerRenderProps } from '@douyinfe/semi-ui/lib/es/treeSelect';
-import { EffectOptions, ASTNodeJSON, ASTNode, BaseType } from '@flowgram.ai/editor';
+import { EffectOptions, ASTNodeJSON, ASTNode, BaseType, FormPluginCreator } from '@flowgram.ai/editor';
+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;
@@ -23,6 +28,21 @@ interface IJsonSchema<T = string> {
 }
 type IBasicJsonSchema = IJsonSchema<JsonSchemaBasicType>;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function useVariableTree(params: {
+    includeSchema?: IJsonSchema | IJsonSchema[];
+    excludeSchema?: IJsonSchema | IJsonSchema[];
+}): TreeNodeData[];
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes$2 {
     value?: string[];
     config?: {
@@ -38,8 +58,13 @@ interface PropTypes$2 {
     triggerRender?: (props: TriggerRenderProps) => React$1.ReactNode;
 }
 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;
@@ -59,6 +84,11 @@ interface IFlowTemplateValue {
 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;
 };
@@ -67,6 +97,11 @@ declare const ArrayIcons: {
 };
 declare const getSchemaIcon: (value?: Partial<IJsonSchema>) => React$1.ReactNode;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes$1 {
     value?: Partial<IJsonSchema>;
     onChange: (value?: Partial<IJsonSchema>) => void;
@@ -77,6 +112,11 @@ declare const getTypeSelectValue: (value?: Partial<IJsonSchema>) => string[] | u
 declare const parseTypeSelectValue: (value?: string[]) => Partial<IJsonSchema> | undefined;
 declare function TypeSelector(props: PropTypes$1): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface ConfigType {
     placeholder?: string;
     descTitle?: string;
@@ -87,6 +127,11 @@ interface ConfigType {
     jsonFormatText?: string;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function JsonSchemaEditor(props: {
     value?: IJsonSchema;
     onChange?: (value: IJsonSchema) => void;
@@ -94,8 +139,18 @@ declare function JsonSchemaEditor(props: {
     className?: string;
 }): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare function BatchVariableSelector(props: VariableSelectorProps): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface Strategy<Value = any> {
     hit: (schema: IJsonSchema) => boolean;
     Renderer: React.FC<RendererProps<Value>>;
@@ -105,15 +160,25 @@ interface RendererProps<Value = any> {
     onChange?: (value: Value) => void;
     readonly?: boolean;
 }
-interface PropsType$1 extends RendererProps {
+interface PropsType$2 extends RendererProps {
     schema: IJsonSchema;
     strategies?: Strategy[];
     [key: string]: any;
 }
 
-declare function ConstantInput(props: PropsType$1): React$1.JSX.Element;
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
-interface PropsType {
+declare function ConstantInput(props: PropsType$2): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$1 {
     value?: IFlowConstantRefValue;
     onChange: (value?: IFlowConstantRefValue) => void;
     readonly?: boolean;
@@ -122,10 +187,16 @@ interface PropsType {
     schema?: IJsonSchema;
     constantProps?: {
         strategies?: Strategy[];
+        schema?: IJsonSchema;
         [key: string]: any;
     };
 }
-declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType): React$1.JSX.Element;
+declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType$1): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 
 declare enum Op {
     EQ = "eq",
@@ -149,6 +220,11 @@ interface ConditionRowValueType {
     right?: IFlowConstantRefValue;
 }
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 interface PropTypes {
     value?: ConditionRowValueType;
     onChange: (value?: ConditionRowValueType) => void;
@@ -157,10 +233,46 @@ interface PropTypes {
 }
 declare function ConditionRow({ style, value, onChange, readonly }: PropTypes): React$1.JSX.Element;
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type ValueType = Record<string, IFlowRefValue | undefined>;
+interface PropsType {
+    value?: ValueType;
+    onChange: (value?: ValueType) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    style?: React.CSSProperties;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function BatchOutputs(props: PropsType): 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
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const provideBatchOutputsEffect: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 /**
  * Auto rename ref when form item's key is renamed
  *
@@ -174,10 +286,24 @@ declare const provideBatchOutputsEffect: EffectOptions[];
  */
 declare const autoRenameRefEffect: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const provideJsonSchemaOutputs: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare const syncVariableTitle: EffectOptions[];
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
 interface LegacyFlowRefValueSchema {
     type: 'ref';
     content: string;
@@ -258,6 +384,11 @@ declare function formatNewRefToLegacyRef(value: NewFlowRefValueSchema): {
     content: string;
 };
 
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
 declare namespace JsonSchemaUtils {
     /**
      * Converts a JSON schema to an Abstract Syntax Tree (AST) representation.
@@ -287,4 +418,16 @@ declare namespace JsonSchemaUtils {
     function isASTMatchSchema(typeAST: BaseType, schema: IJsonSchema | IJsonSchema[]): boolean;
 }
 
-export { ArrayIcons, BatchVariableSelector, ConditionRow, type ConditionRowValueType, ConstantInput, DynamicValueInput, type IBasicJsonSchema, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IJsonSchema, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle };
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+/**
+ * Free Layout only right now
+ */
+declare const createBatchOutputsFormPlugin: FormPluginCreator<{
+    outputKey: string;
+}>;
+
+export { ArrayIcons, BatchOutputs, BatchVariableSelector, ConditionRow, type ConditionRowValueType, ConstantInput, DynamicValueInput, type IBasicJsonSchema, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IJsonSchema, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, createBatchOutputsFormPlugin, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle, useVariableTree };