@flowgram.ai/form-materials 0.2.30 → 0.2.32

package/dist/index.d.ts

@@ -0,0 +1,553 @@
+import React$1 from 'react';
+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 { BaseVariableField, EffectOptions, ASTNodeJSON, ASTNode, BaseType, FormPluginCreator } from '@flowgram.ai/editor';
+import * as _flowgram_ai_node from '@flowgram.ai/node';
+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;
+}>;
+declare function useVariableTree(params: {
+    includeSchema?: IJsonSchema | IJsonSchema[];
+    excludeSchema?: IJsonSchema | IJsonSchema[];
+    customSkip?: (variable: VariableField) => boolean;
+}): TreeNodeData[];
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropTypes$2 {
+    value?: string[];
+    config?: {
+        placeholder?: string;
+        notFoundContent?: string;
+    };
+    onChange: (value?: string[]) => void;
+    includeSchema?: IJsonSchema | IJsonSchema[];
+    excludeSchema?: IJsonSchema | IJsonSchema[];
+    readonly?: boolean;
+    hasError?: boolean;
+    style?: React$1.CSSProperties;
+    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 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
+ */
+
+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
+ */
+
+interface PropTypes$1 {
+    value?: Partial<IJsonSchema>;
+    onChange?: (value?: Partial<IJsonSchema>) => void;
+    readonly?: boolean;
+    /**
+     * @deprecated use readonly instead
+     */
+    disabled?: boolean;
+    style?: React$1.CSSProperties;
+}
+declare const getTypeSelectValue: (value?: Partial<IJsonSchema>) => string[] | undefined;
+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;
+    descPlaceholder?: string;
+    defaultValueTitle?: string;
+    defaultValuePlaceholder?: string;
+    addButtonText?: string;
+    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;
+    config?: ConfigType;
+    className?: string;
+    readonly?: boolean;
+}): 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>>;
+}
+interface RendererProps<Value = any> {
+    value?: Value;
+    onChange?: (value: Value) => void;
+    readonly?: boolean;
+}
+interface PropsType$5 extends RendererProps {
+    schema: IJsonSchema;
+    strategies?: Strategy[];
+    fallbackRenderer?: React.FC<RendererProps>;
+    [key: string]: any;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function ConstantInput(props: PropsType$5): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$4 {
+    value?: IFlowConstantRefValue;
+    onChange: (value?: IFlowConstantRefValue) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    style?: React$1.CSSProperties;
+    schema?: IJsonSchema;
+    constantProps?: {
+        strategies?: Strategy[];
+        schema?: IJsonSchema;
+        [key: string]: any;
+    };
+}
+declare function DynamicValueInput({ value, onChange, readonly, style, schema: schemaFromProps, constantProps, }: PropsType$4): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare enum Op {
+    EQ = "eq",
+    NEQ = "neq",
+    GT = "gt",
+    GTE = "gte",
+    LT = "lt",
+    LTE = "lte",
+    IN = "in",
+    NIN = "nin",
+    CONTAINS = "contains",
+    NOT_CONTAINS = "not_contains",
+    IS_EMPTY = "is_empty",
+    IS_NOT_EMPTY = "is_not_empty",
+    IS_TRUE = "is_true",
+    IS_FALSE = "is_false"
+}
+interface ConditionRowValueType {
+    left?: IFlowRefValue;
+    operator?: Op;
+    right?: IFlowConstantRefValue;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropTypes {
+    value?: ConditionRowValueType;
+    onChange: (value?: ConditionRowValueType) => void;
+    style?: React$1.CSSProperties;
+    readonly?: boolean;
+}
+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$3 {
+    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$3): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type PropsType$2 = React$1.PropsWithChildren<{
+    value?: IFlowTemplateValue;
+    onChange: (value?: IFlowTemplateValue) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    placeholder?: string;
+    activeLinePlaceholder?: string;
+    disableMarkdownHighlight?: boolean;
+    style?: React$1.CSSProperties;
+}>;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type PromptEditorPropsType = PropsType$2;
+declare function PromptEditor(props: PropsType$2): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+declare function PromptEditorWithVariables(props: PromptEditorPropsType): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType$1 extends PromptEditorPropsType {
+    inputsValues: Record<string, IFlowValue>;
+}
+declare function PromptEditorWithInputs({ inputsValues, ...restProps }: PropsType$1): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+type Preset = typeof preset;
+type Options = Partial<InferValues<Preset[number]>>;
+interface CodeEditorPropsType extends React$1.PropsWithChildren<{}> {
+    value?: string;
+    onChange?: (value: string) => void;
+    languageId: 'python' | 'typescript' | 'shell' | 'json';
+    theme?: 'dark' | 'light';
+    placeholder?: string;
+    activeLinePlaceholder?: string;
+    readonly?: boolean;
+    options?: Options;
+}
+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 JsonEditorWithVariables(props: Omit<CodeEditorPropsType, 'languageId'>): React$1.JSX.Element;
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+interface PropsType {
+    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 function InputsValues({ value, onChange, style, readonly, constantProps, schema, hasError, }: 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
+ */
+
+/**
+ * Auto rename ref when form item's key is renamed
+ *
+ * Example:
+ *
+ * formMeta: {
+ *  effects: {
+ *    "inputsValues": autoRenameRefEffect,
+ *  }
+ * }
+ */
+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;
+}
+interface NewFlowRefValueSchema {
+    type: 'ref';
+    content: string[];
+}
+/**
+ * In flowgram 0.2.0, for introducing Loop variable functionality,
+ * the FlowRefValueSchema type definition is updated:
+ *
+ * interface LegacyFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string;
+ * }
+ *
+ * interface NewFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string[];
+ * }
+ *
+ *
+ * For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData
+ *
+ * How to use:
+ *
+ * 1. Call formatLegacyRefOnSubmit on the formData before submitting
+ * 2. Call formatLegacyRefOnInit on the formData after submitting
+ *
+ * Example:
+ * import { formatLegacyRefOnSubmit, formatLegacyRefOnInit } from '@flowgram.ai/form-materials';
+ * formMeta: {
+ *  formatOnSubmit: (data) => formatLegacyRefOnSubmit(data),
+ *  formatOnInit: (data) => formatLegacyRefOnInit(data),
+ * }
+ */
+declare function formatLegacyRefOnSubmit(value: any): any;
+/**
+ * In flowgram 0.2.0, for introducing Loop variable functionality,
+ * the FlowRefValueSchema type definition is updated:
+ *
+ * interface LegacyFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string;
+ * }
+ *
+ * interface NewFlowRefValueSchema {
+ *  type: 'ref';
+ *  content: string[];
+ * }
+ *
+ *
+ * For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData
+ *
+ * How to use:
+ *
+ * 1. Call formatLegacyRefOnSubmit on the formData before submitting
+ * 2. Call formatLegacyRefOnInit on the formData after submitting
+ *
+ * Example:
+ * import { formatLegacyRefOnSubmit, formatLegacyRefOnInit } from '@flowgram.ai/form-materials';
+ *
+ * formMeta: {
+ *  formatOnSubmit: (data) => formatLegacyRefOnSubmit(data),
+ *  formatOnInit: (data) => formatLegacyRefOnInit(data),
+ * }
+ */
+declare function formatLegacyRefOnInit(value: any): any;
+declare function isLegacyFlowRefValueSchema(value: any): value is LegacyFlowRefValueSchema;
+declare function isNewFlowRefValueSchema(value: any): value is NewFlowRefValueSchema;
+declare function formatLegacyRefToNewRef(value: LegacyFlowRefValueSchema): {
+    type: string;
+    content: string[];
+};
+declare function formatNewRefToLegacyRef(value: NewFlowRefValueSchema): {
+    type: string;
+    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.
+     * 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;
+}
+
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+
+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 {
+    sourceKey: string;
+    targetKey: string;
+    scope?: 'private' | 'public';
+}
+declare const createInferInputsPlugin: _flowgram_ai_node.FormPluginCreator<InputConfig>;
+
+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 IFlowValueExtra, type IJsonSchema, InputsValues, JsonEditorWithVariables, type JsonSchemaBasicType, JsonSchemaEditor, JsonSchemaUtils, PromptEditor, type PromptEditorPropsType, PromptEditorWithInputs, PromptEditorWithVariables, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, autoRenameRefEffect, createBatchOutputsFormPlugin, createInferInputsPlugin, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect, provideJsonSchemaOutputs, syncVariableTitle, useVariableTree };