@flowgram.ai/form-materials 0.4.9 → 0.4.10

package/dist/types/effects/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { autoRenameRefEffect } from './auto-rename-ref';
+export { listenRefSchemaChange } from './listen-ref-schema-change';
+export { listenRefValueChange } from './listen-ref-value-change';
+export { provideBatchInputEffect } from './provide-batch-input';
+export { provideJsonSchemaOutputs } from './provide-json-schema-outputs';
+export { syncVariableTitle } from './sync-variable-title';
+export { validateWhenVariableSync } from './validate-when-variable-sync';

package/dist/types/effects/listen-ref-schema-change/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { IJsonSchema } from '@flowgram.ai/json-schema';
+import { EffectFuncProps, EffectOptions } from '@flowgram.ai/editor';
+import { IFlowRefValue } from '../../shared';
+/**
+ * Example:
+ * const formMeta = {
+ *   effect: {
+ *     'inputsValues.*': listenRefSchemaChange(({ name, schema, form }) => {
+ *       form.setValueIn(`${name}.schema`, schema);
+ *     })
+ *   }
+ * }
+ * @param cb
+ * @returns
+ */
+export declare const listenRefSchemaChange: (cb: (props: EffectFuncProps<IFlowRefValue> & {
+    schema?: IJsonSchema;
+}) => void) => EffectOptions[];

package/dist/types/effects/listen-ref-value-change/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { BaseVariableField, EffectFuncProps, EffectOptions } from '@flowgram.ai/editor';
+import { IFlowRefValue } from '../../shared';
+/**
+ * Example:
+ * const formMeta = {
+ *   effect: {
+ *     'inputsValues.*': listenRefValueChange(({ name, variable, form }) => {
+ *       const schema = JsonSchemaUtils.astToSchema(variable?.type);
+ *       form.setValueIn(`${name}.schema`, schema);
+ *     })
+ *   }
+ * }
+ * @param cb
+ * @returns
+ */
+export declare const listenRefValueChange: (cb: (props: EffectFuncProps<IFlowRefValue> & {
+    variable?: BaseVariableField;
+}) => void) => EffectOptions[];

package/dist/types/effects/provide-batch-input/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { EffectOptions } from '@flowgram.ai/editor';
+export declare const provideBatchInputEffect: EffectOptions[];

package/dist/types/effects/provide-json-schema-outputs/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { EffectOptions } from '@flowgram.ai/editor';
+export declare const provideJsonSchemaOutputs: EffectOptions[];

package/dist/types/effects/sync-variable-title/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { EffectOptions } from '@flowgram.ai/editor';
+export declare const syncVariableTitle: EffectOptions[];

package/dist/types/effects/validate-when-variable-sync/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { EffectOptions } from '@flowgram.ai/editor';
+export declare const validateWhenVariableSync: ({ scope, }?: {
+    scope?: "private" | "public";
+}) => EffectOptions[];

package/dist/types/form-plugins/batch-outputs-plugin/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type EffectOptions, type FormPluginCreator } from '@flowgram.ai/editor';
+export declare const provideBatchOutputsEffect: EffectOptions[];
+/**
+ * Free Layout only right now
+ */
+export declare const createBatchOutputsFormPlugin: FormPluginCreator<{
+    outputKey: string;
+}>;

package/dist/types/form-plugins/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { createBatchOutputsFormPlugin, provideBatchOutputsEffect } from './batch-outputs-plugin';
+export { createInferAssignPlugin } from './infer-assign-plugin';
+export { createInferInputsPlugin } from './infer-inputs-plugin';

package/dist/types/form-plugins/infer-assign-plugin/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+interface InputConfig {
+    assignKey: string;
+    outputKey: string;
+}
+export declare const createInferAssignPlugin: import("@flowgram.ai/node").FormPluginCreator<InputConfig>;
+export {};

package/dist/types/form-plugins/infer-inputs-plugin/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+interface InputConfig {
+    sourceKey: string;
+    targetKey: string;
+    scope?: 'private' | 'public';
+}
+export declare const createInferInputsPlugin: import("@flowgram.ai/node").FormPluginCreator<InputConfig>;
+export {};

package/dist/types/hooks/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { useObjectList } from './use-object-list';

package/dist/types/hooks/use-object-list/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+interface ListItem<ValueType> {
+    id: string;
+    key?: string;
+    value?: ValueType;
+}
+type ObjectType<ValueType> = Record<string, ValueType | undefined>;
+export declare function useObjectList<ValueType>({ value, onChange, sortIndexKey, }: {
+    value?: ObjectType<ValueType>;
+    onChange: (value?: ObjectType<ValueType>) => void;
+    sortIndexKey?: string | ((item: ValueType | undefined) => string);
+}): {
+    list: ListItem<ValueType>[];
+    add: (defaultValue?: ValueType) => void;
+    updateKey: (itemId: string, key: string) => void;
+    updateValue: (itemId: string, value: ValueType) => void;
+    remove: (itemId: string) => void;
+};
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { AssignRow, AssignRows, BatchOutputs, BatchVariableSelector, BlurInput, CodeEditor, CodeEditorMini, ConditionRow, ConstantInput, DBConditionRow, DisplayFlowValue, DisplayInputsValueAllInTag, DisplayInputsValues, DisplayOutputs, DisplaySchemaTag, DisplaySchemaTree, DynamicValueInput, InjectDynamicValueInput, InjectTypeSelector, InjectVariableSelector, InputsValues, InputsValuesTree, JsonEditorWithVariables, JsonSchemaEditor, PromptEditor, PromptEditorWithInputs, PromptEditorWithVariables, TypeSelector, VariableSelector, VariableSelectorProvider, getTypeSelectValue, parseTypeSelectValue, type AssignValueType, type CodeEditorPropsType, type ConditionRowValueType, type ConstantInputStrategy, type DBConditionOptionType, type DBConditionRowValueType, type JsonEditorWithVariablesProps, type PromptEditorPropsType, type PromptEditorWithInputsProps, type PromptEditorWithVariablesProps, type TypeSelectorProps, type VariableSelectorProps, useVariableTree, } from './components';
+export { autoRenameRefEffect, listenRefSchemaChange, listenRefValueChange, provideBatchInputEffect, provideJsonSchemaOutputs, syncVariableTitle, validateWhenVariableSync, } from './effects';
+export { createBatchOutputsFormPlugin, createInferAssignPlugin, createInferInputsPlugin, provideBatchOutputsEffect, } from './form-plugins';
+export { useObjectList } from './hooks';
+export { JsonSchemaTypePresetProvider, JsonSchemaUtils, createDisableDeclarationPlugin, createTypePresetPlugin, type ConstantRendererProps, type IJsonSchema, type JsonSchemaBasicType, type JsonSchemaTypeRegistry, useTypeManager, } from './plugins';
+export { FlowValueUtils, createInjectMaterial, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, lazySuspense, polyfillCreateRoot, type FlowValueType, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IFlowValueExtra, type IPolyfillRoot, unstableSetCreateRoot, withSuspense, } from './shared';
+export { validateFlowValue } from './validate';

package/dist/types/plugins/disable-declaration-plugin/create-disable-declaration-plugin.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export declare const createDisableDeclarationPlugin: import("@flowgram.ai/core").PluginCreator<void>;

package/dist/types/plugins/disable-declaration-plugin/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { createDisableDeclarationPlugin } from './create-disable-declaration-plugin';

package/dist/types/plugins/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { createDisableDeclarationPlugin } from './disable-declaration-plugin';
+export { JsonSchemaTypePresetProvider, JsonSchemaUtils, createTypePresetPlugin, type ConstantRendererProps, type IJsonSchema, type JsonSchemaBasicType, type JsonSchemaTypeRegistry, useTypeManager, } from './json-schema-preset';

package/dist/types/plugins/json-schema-preset/create-type-preset-plugin.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { JsonSchemaTypeRegistry } from './manager';
+export declare const createTypePresetPlugin: import("@flowgram.ai/core").PluginCreator<{
+    types?: Partial<JsonSchemaTypeRegistry> & Pick<JsonSchemaTypeRegistry, "type">[];
+    unregisterTypes?: string[];
+}>;

package/dist/types/plugins/json-schema-preset/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import React from 'react';
+import { type IJsonSchema, JsonSchemaUtils, JsonSchemaTypeManager, type JsonSchemaBasicType } from '@flowgram.ai/json-schema';
+import { type JsonSchemaTypeRegistry, type ConstantRendererProps } from './manager';
+import { createTypePresetPlugin } from './create-type-preset-plugin';
+declare const useTypeManager: () => JsonSchemaTypeManager<IJsonSchema, JsonSchemaTypeRegistry>;
+declare const JsonSchemaTypePresetProvider: ({ types, children, }: React.PropsWithChildren<{
+    types: JsonSchemaTypeRegistry[];
+}>) => React.JSX.Element;
+export { createTypePresetPlugin, useTypeManager, JsonSchemaTypePresetProvider, JsonSchemaUtils, type IJsonSchema, type JsonSchemaTypeRegistry, type ConstantRendererProps, type JsonSchemaBasicType, };

package/dist/types/plugins/json-schema-preset/manager.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { JsonSchemaTypeRegistry as OriginJsonSchemaTypeRegistry } from '@flowgram.ai/json-schema';
+export interface ConstantRendererProps<Value = any> {
+    value?: Value;
+    onChange?: (value: Value) => void;
+    readonly?: boolean;
+    [key: string]: any;
+}
+export interface JsonSchemaTypeRegistry<Value = any> extends OriginJsonSchemaTypeRegistry {
+    /**
+     * Render Constant Input
+     */
+    ConstantRenderer: React.FC<ConstantRendererProps<Value>>;
+}

package/dist/types/plugins/json-schema-preset/type-definition/array.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const arrayRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/boolean.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const booleanRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/date-time.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const dateTimeRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export declare const jsonSchemaTypePreset: Partial<import("..").JsonSchemaTypeRegistry<any>>[];

package/dist/types/plugins/json-schema-preset/type-definition/integer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const integerRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/number.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const numberRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/object.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const objectRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/plugins/json-schema-preset/type-definition/string.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { type JsonSchemaTypeRegistry } from '../manager';
+export declare const stringRegistry: Partial<JsonSchemaTypeRegistry>;

package/dist/types/shared/flow-value/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { FlowValueUtils } from './utils';
+export { type IFlowValueExtra, type FlowValueType, type IFlowValue, type IFlowConstantValue, type IFlowRefValue, type IFlowExpressionValue, type IFlowTemplateValue, type IFlowConstantRefValue, } from './types';

package/dist/types/shared/flow-value/schema.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import z from 'zod';
+export declare const extraSchema: z.ZodOptional<z.ZodObject<{
+    index: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    index?: number | undefined;
+}, {
+    index?: number | undefined;
+}>>;
+export declare const constantSchema: z.ZodObject<{
+    type: z.ZodLiteral<"constant">;
+    content: z.ZodOptional<z.ZodAny>;
+    schema: z.ZodOptional<z.ZodAny>;
+    extra: z.ZodOptional<z.ZodObject<{
+        index: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        index?: number | undefined;
+    }, {
+        index?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "constant";
+    content?: any;
+    schema?: any;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}, {
+    type: "constant";
+    content?: any;
+    schema?: any;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}>;
+export declare const refSchema: z.ZodObject<{
+    type: z.ZodLiteral<"ref">;
+    content: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    extra: z.ZodOptional<z.ZodObject<{
+        index: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        index?: number | undefined;
+    }, {
+        index?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "ref";
+    content?: string[] | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}, {
+    type: "ref";
+    content?: string[] | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}>;
+export declare const expressionSchema: z.ZodObject<{
+    type: z.ZodLiteral<"expression">;
+    content: z.ZodOptional<z.ZodString>;
+    extra: z.ZodOptional<z.ZodObject<{
+        index: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        index?: number | undefined;
+    }, {
+        index?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "expression";
+    content?: string | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}, {
+    type: "expression";
+    content?: string | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}>;
+export declare const templateSchema: z.ZodObject<{
+    type: z.ZodLiteral<"template">;
+    content: z.ZodOptional<z.ZodString>;
+    extra: z.ZodOptional<z.ZodObject<{
+        index: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        index?: number | undefined;
+    }, {
+        index?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    type: "template";
+    content?: string | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}, {
+    type: "template";
+    content?: string | undefined;
+    extra?: {
+        index?: number | undefined;
+    } | undefined;
+}>;

package/dist/types/shared/flow-value/types.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { IJsonSchema } from '@flowgram.ai/json-schema';
+export interface IFlowValueExtra {
+    index?: number;
+}
+export type FlowValueType = 'constant' | 'ref' | 'expression' | 'template';
+export interface IFlowConstantValue {
+    type: 'constant';
+    content?: any;
+    schema?: IJsonSchema;
+    extra?: IFlowValueExtra;
+}
+export interface IFlowRefValue {
+    type: 'ref';
+    content?: string[];
+    extra?: IFlowValueExtra;
+}
+export interface IFlowExpressionValue {
+    type: 'expression';
+    content?: string;
+    extra?: IFlowValueExtra;
+}
+export interface IFlowTemplateValue {
+    type: 'template';
+    content?: string;
+    extra?: IFlowValueExtra;
+}
+export type IFlowValue = IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue;
+export type IFlowConstantRefValue = IFlowConstantValue | IFlowRefValue;

package/dist/types/shared/flow-value/utils.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+import { IJsonSchema } from '@flowgram.ai/json-schema';
+import { Scope } from '@flowgram.ai/editor';
+import { IFlowConstantValue, IFlowRefValue, IFlowExpressionValue, IFlowTemplateValue, IFlowValue, IFlowConstantRefValue, FlowValueType } from './types';
+export declare namespace FlowValueUtils {
+    /**
+     * Check if the value is a constant type
+     */
+    function isConstant(value: any): value is IFlowConstantValue;
+    /**
+     * Check if the value is a reference type
+     */
+    function isRef(value: any): value is IFlowRefValue;
+    /**
+     * Check if the value is an expression type
+     */
+    function isExpression(value: any): value is IFlowExpressionValue;
+    /**
+     * Check if the value is a template type
+     */
+    function isTemplate(value: any): value is IFlowTemplateValue;
+    /**
+     * Check if the value is either a constant or reference type
+     */
+    function isConstantOrRef(value: any): value is IFlowConstantRefValue;
+    /**
+     * Check if the value is a valid flow value type
+     */
+    function isFlowValue(value: any): value is IFlowValue;
+    /**
+     * Traverse all flow values in the given value
+     * @param value The value to traverse
+     * @param options The options to traverse
+     * @returns A generator of flow values
+     */
+    function traverse(value: any, options: {
+        includeTypes?: FlowValueType[];
+        path?: string;
+    }): Generator<{
+        value: IFlowValue;
+        path: string;
+    }>;
+    /**
+     * Get all key paths in the template value
+     * @param value The template value
+     * @returns A list of key paths
+     */
+    function getTemplateKeyPaths(value: IFlowTemplateValue): string[][];
+    /**
+     * Infer the schema of the constant value
+     * @param value
+     * @returns
+     */
+    function inferConstantJsonSchema(value: IFlowConstantValue): IJsonSchema | undefined;
+    /**
+     * Infer the schema of the flow value
+     * @param values The flow value or object contains flow value
+     * @param scope
+     * @returns
+     */
+    function inferJsonSchema(values: any, scope: Scope): IJsonSchema | undefined;
+}

package/dist/types/shared/format-legacy-refs/index.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 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),
+ * }
+ */
+export 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),
+ * }
+ */
+export declare function formatLegacyRefOnInit(value: any): any;
+export declare function isLegacyFlowRefValueSchema(value: any): value is LegacyFlowRefValueSchema;
+export declare function isNewFlowRefValueSchema(value: any): value is NewFlowRefValueSchema;
+export declare function formatLegacyRefToNewRef(value: LegacyFlowRefValueSchema): {
+    type: string;
+    content: string[];
+};
+export declare function formatNewRefToLegacyRef(value: NewFlowRefValueSchema): {
+    type: string;
+    content: string;
+};
+export {};

package/dist/types/shared/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) 2025 Bytedance Ltd. and/or its affiliates
+ * SPDX-License-Identifier: MIT
+ */
+export { FlowValueUtils, type FlowValueType, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type IFlowValueExtra, } from './flow-value';
+export { formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, } from './format-legacy-refs';
+export { createInjectMaterial } from './inject-material';
+export { lazySuspense, withSuspense } from './lazy-suspense';
+export { polyfillCreateRoot, unstableSetCreateRoot, type IPolyfillRoot, } from './polyfill-create-root';