@flowgram.ai/form-materials 0.1.30 → 0.2.0

package/dist/index.d.ts

@@ -1,48 +1,191 @@
-import React from 'react';
+import React$1 from 'react';
+import { VarJSONSchema, EffectOptions } from '@flowgram.ai/editor';
+import { TriggerRenderProps } from '@douyinfe/semi-ui/lib/es/treeSelect';
 
 interface PropTypes$1 {
-    value?: string;
-    onChange: (value?: string) => void;
+    value?: string[];
+    config?: {
+        placeholder?: string;
+        notFoundContent?: string;
+    };
+    onChange: (value?: string[]) => void;
+    includeSchema?: VarJSONSchema.ISchema | VarJSONSchema.ISchema[];
+    excludeSchema?: VarJSONSchema.ISchema | VarJSONSchema.ISchema[];
     readonly?: boolean;
     hasError?: boolean;
-    style?: React.CSSProperties;
-}
-declare const VariableSelector: ({ value, onChange, style, readonly, hasError, }: PropTypes$1) => React.JSX.Element;
-
-interface JsonSchema<T = string> {
-    type?: T;
-    default?: any;
-    title?: string;
-    description?: string;
-    enum?: (string | number)[];
-    properties?: Record<string, JsonSchema>;
-    additionalProperties?: JsonSchema;
-    items?: JsonSchema;
-    required?: string[];
-    $ref?: string;
-    extra?: {
-        order?: number;
-        literal?: boolean;
-        formComponent?: string;
-    };
+    style?: React$1.CSSProperties;
+    triggerRender?: (props: TriggerRenderProps) => React$1.ReactNode;
 }
+type VariableSelectorProps = PropTypes$1;
+declare const VariableSelector: ({ value, config, onChange, style, readonly, includeSchema, excludeSchema, hasError, triggerRender, }: PropTypes$1) => React$1.JSX.Element;
+
+type JsonSchema = VarJSONSchema.ISchema;
 
 declare const VariableTypeIcons: {
-    [key: string]: React.ReactNode;
+    [key: string]: React$1.ReactNode;
 };
 declare const ArrayIcons: {
-    [key: string]: React.ReactNode;
+    [key: string]: React$1.ReactNode;
 };
+declare const getSchemaIcon: (value?: Partial<JsonSchema>) => React$1.ReactNode;
 
 interface PropTypes {
     value?: Partial<JsonSchema>;
     onChange: (value?: Partial<JsonSchema>) => void;
+    disabled?: boolean;
+    style?: React$1.CSSProperties;
+}
+declare const getTypeSelectValue: (value?: Partial<JsonSchema>) => string[] | undefined;
+declare const parseTypeSelectValue: (value?: string[]) => Partial<JsonSchema> | undefined;
+declare function TypeSelector(props: PropTypes): React$1.JSX.Element;
+
+interface ConfigType {
+    placeholder?: string;
+    descTitle?: string;
+    descPlaceholder?: string;
+    addButtonText?: string;
 }
-declare function TypeSelector(props: PropTypes): React.JSX.Element;
 
 declare function JsonSchemaEditor(props: {
     value?: JsonSchema;
     onChange?: (value: JsonSchema) => void;
-}): React.JSX.Element;
+    config?: ConfigType;
+}): React$1.JSX.Element;
+
+declare function BatchVariableSelector(props: VariableSelectorProps): React$1.JSX.Element;
+
+interface Strategy<Value = any> {
+    hit: (schema: VarJSONSchema.ISchema) => boolean;
+    Renderer: React.FC<RendererProps<Value>>;
+}
+interface RendererProps<Value = any> {
+    value?: Value;
+    onChange?: (value: Value) => void;
+    readonly?: boolean;
+}
+interface PropsType$1 extends RendererProps {
+    schema: VarJSONSchema.ISchema;
+    strategies?: Strategy[];
+    [key: string]: any;
+}
+
+declare function ConstantInput(props: PropsType$1): React$1.JSX.Element;
+
+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;
+
+interface PropsType {
+    value?: IFlowConstantRefValue;
+    onChange: (value?: IFlowConstantRefValue) => void;
+    readonly?: boolean;
+    hasError?: boolean;
+    style?: React$1.CSSProperties;
+    schema?: VarJSONSchema.ISchema;
+    constantProps?: {
+        strategies?: Strategy[];
+        [key: string]: any;
+    };
+}
+declare function DynamicValueInput({ value, onChange, readonly, style, schema, constantProps, }: PropsType): React$1.JSX.Element;
+
+declare const provideBatchInputEffect: EffectOptions[];
+
+declare const provideBatchOutputsEffect: EffectOptions[];
+
+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;
+};
 
-export { ArrayIcons, type JsonSchema, JsonSchemaEditor, TypeSelector, VariableSelector, VariableTypeIcons };
+export { ArrayIcons, BatchVariableSelector, ConstantInput, DynamicValueInput, type IFlowConstantRefValue, type IFlowConstantValue, type IFlowExpressionValue, type IFlowRefValue, type IFlowTemplateValue, type IFlowValue, type JsonSchema, JsonSchemaEditor, TypeSelector, VariableSelector, type VariableSelectorProps, VariableTypeIcons, formatLegacyRefOnInit, formatLegacyRefOnSubmit, formatLegacyRefToNewRef, formatNewRefToLegacyRef, getSchemaIcon, getTypeSelectValue, isLegacyFlowRefValueSchema, isNewFlowRefValueSchema, parseTypeSelectValue, provideBatchInputEffect, provideBatchOutputsEffect };