@uipath/apollo-wind 2.60.1 → 2.62.0

package/dist/components/forms/metadata-form.cjs

@@ -48,9 +48,13 @@ const tabs_cjs_namespaceObject = require("../ui/tabs.cjs");
 const tooltip_cjs_namespaceObject = require("../ui/tooltip.cjs");
 const index_cjs_namespaceObject = require("../../lib/index.cjs");
 const external_data_fetcher_cjs_namespaceObject = require("./data-fetcher.cjs");
+const external_field_actions_cjs_namespaceObject = require("./field-actions.cjs");
 const external_field_renderer_cjs_namespaceObject = require("./field-renderer.cjs");
+const external_form_strings_cjs_namespaceObject = require("./form-strings.cjs");
+const external_literal_value_context_cjs_namespaceObject = require("./literal-value-context.cjs");
 const external_rules_engine_cjs_namespaceObject = require("./rules-engine.cjs");
 const external_validation_converter_cjs_namespaceObject = require("./validation-converter.cjs");
+const external_value_modes_cjs_namespaceObject = require("./value-modes.cjs");
 const DEFAULT_PLUGINS = [];
 function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className, disabled = false, autoComplete, stepVariant = 'wizard', sectionVariant = 'card', activeStepId, onActiveStepChange, container = 'form' }) {
     const [currentStep, setCurrentStep] = (0, external_react_namespaceObject.useState)(0);
@@ -69,12 +73,41 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
             ...stableSchema.sections ?? [],
             ...(stableSchema.steps ?? []).flatMap((step)=>step.sections)
         ];
-        return sections.some((section)=>section.fields.some((field)=>void 0 !== field.tooltip));
+        return sections.some((section)=>section.fields.some((field)=>void 0 !== field.tooltip || void 0 !== field.valueModes || !!field.headerActions));
     }, [
         stableSchema
     ]);
-    const zodSchema = (0, external_react_namespaceObject.useMemo)(()=>buildZodSchema(stableSchema), [
-        stableSchema
+    const stablePlugins = useShallowStable(plugins);
+    const valueModeRegistry = (0, external_react_namespaceObject.useMemo)(()=>(0, external_value_modes_cjs_namespaceObject.buildValueModeRegistry)(stablePlugins), [
+        stablePlugins
+    ]);
+    const fieldActionRegistry = (0, external_react_namespaceObject.useMemo)(()=>(0, external_field_actions_cjs_namespaceObject.buildFieldActionRegistry)(stablePlugins), [
+        stablePlugins
+    ]);
+    const formStrings = (0, external_react_namespaceObject.useMemo)(()=>(0, external_form_strings_cjs_namespaceObject.buildFormStrings)(stablePlugins), [
+        stablePlugins
+    ]);
+    const readLiteralValue = (0, external_react_namespaceObject.useCallback)((name, stored)=>(0, external_value_modes_cjs_namespaceObject.literalValueOf)(name, stored, stableSchema, valueModeRegistry.codecs), [
+        stableSchema,
+        valueModeRegistry
+    ]);
+    const formVariables = (0, external_react_namespaceObject.useMemo)(()=>[
+            ...stablePlugins
+        ].reverse().find((plugin)=>plugin.variables)?.variables, [
+        stablePlugins
+    ]);
+    const codecs = useShallowStable(valueModeRegistry.codecs);
+    const validators = useShallowStable(modeValidators(valueModeRegistry));
+    const requiredMessage = formStrings.validation.required;
+    const zodSchema = (0, external_react_namespaceObject.useMemo)(()=>buildZodSchema(stableSchema, {
+            codecs,
+            validators,
+            requiredMessage
+        }), [
+        stableSchema,
+        codecs,
+        validators,
+        requiredMessage
     ]);
     const form = (0, external_react_hook_form_namespaceObject.useForm)({
         resolver: (0, standard_schema_namespaceObject.standardSchemaResolver)(zodSchema),
@@ -88,7 +121,9 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     pluginsRef.current = plugins;
     const onSubmitRef = (0, external_react_namespaceObject.useRef)(onSubmit);
     onSubmitRef.current = onSubmit;
-    const context = (0, external_react_namespaceObject.useMemo)(()=>({
+    const context = (0, external_react_namespaceObject.useMemo)(()=>{
+        const readValues = (values)=>(0, external_value_modes_cjs_namespaceObject.literalValues)(values, stableSchema, valueModeRegistry.codecs);
+        return {
             schema: stableSchema,
             form,
             get values () {
@@ -104,9 +139,9 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
                 return form.formState.isDirty;
             },
             currentStep: stableSchema.steps ? currentStep : void 0,
-            evaluateConditions: (conditions)=>external_rules_engine_cjs_namespaceObject.RulesEngine.evaluateConditions(conditions, valuesRef.current, 'AND'),
+            evaluateConditions: (conditions)=>external_rules_engine_cjs_namespaceObject.RulesEngine.evaluateConditions(conditions, readValues(valuesRef.current), 'AND'),
             fetchData: async (source)=>{
-                const result = await external_data_fetcher_cjs_namespaceObject.DataFetcher.fetch(source, valuesRef.current);
+                const result = await external_data_fetcher_cjs_namespaceObject.DataFetcher.fetch(source, readValues(valuesRef.current));
                 return result;
             },
             registerCustomComponent: (name, component)=>{
@@ -114,11 +149,20 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
                         ...prev,
                         [name]: component
                     }));
-            }
-        }), [
+            },
+            valueModes: valueModeRegistry,
+            fieldActions: fieldActionRegistry,
+            strings: formStrings,
+            variables: formVariables
+        };
+    }, [
         stableSchema,
         form,
-        currentStep
+        currentStep,
+        valueModeRegistry,
+        fieldActionRegistry,
+        formStrings,
+        formVariables
     ]);
     const contextRef = (0, external_react_namespaceObject.useRef)(context);
     contextRef.current = context;
@@ -170,13 +214,13 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     ]);
     const allCustomComponents = (0, external_react_namespaceObject.useMemo)(()=>{
         const fromPlugins = {};
-        for (const plugin of plugins)Object.assign(fromPlugins, plugin.components);
+        for (const plugin of stablePlugins)Object.assign(fromPlugins, plugin.components);
         return {
             ...fromPlugins,
             ...customComponents
         };
     }, [
-        plugins,
+        stablePlugins,
         customComponents
     ]);
     const enterSwallowRef = (0, external_react_namespaceObject.useRef)(null);
@@ -248,9 +292,12 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     });
     return /*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)(external_react_hook_form_namespaceObject.FormProvider, {
         ...form,
-        children: hasFieldTooltip ? /*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)(tooltip_cjs_namespaceObject.TooltipProvider, {
-            children: body
-        }) : body
+        children: /*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)(external_literal_value_context_cjs_namespaceObject.LiteralValueContext.Provider, {
+            value: readLiteralValue,
+            children: hasFieldTooltip ? /*#__PURE__*/ (0, jsx_runtime_namespaceObject.jsx)(tooltip_cjs_namespaceObject.TooltipProvider, {
+                children: body
+            }) : body
+        })
     });
 }
 function conditionDependencies(conditionGroups) {
@@ -590,7 +637,12 @@ const metadata_form_FormActions = /*#__PURE__*/ external_react_default().memo(fu
         })
     });
 });
-function buildZodSchema(schema) {
+function modeValidators(registry) {
+    const validators = {};
+    for (const [mode, definition] of Object.entries(registry.definitions))if (definition?.validate) validators[mode] = definition.validate;
+    return validators;
+}
+function buildZodSchema(schema, { codecs, validators, requiredMessage }) {
     const shape = {};
     const fields = schema.steps ? schema.steps.flatMap((step)=>step.sections.flatMap((s)=>s.fields)) : schema.sections?.flatMap((s)=>s.fields) || [];
     const dynamicValidationFields = [];
@@ -601,33 +653,49 @@ function buildZodSchema(schema) {
         const hasStaticRequired = field.validation?.required === true;
         const hasAnyRequired = hasStaticRequired || hasUnconditionalRequired || hasConditionalRequired;
         if (field.rules && (hasConditionalRequired || hasAnyRequired && hasVisibilityRules)) dynamicValidationFields.push({
+            field,
             name: field.name,
             rules: field.rules,
             staticRequired: hasStaticRequired || hasUnconditionalRequired || false,
             customRequiredMessage: field.validation?.messages?.required
         });
         const shouldIncludeRequiredInBase = (hasUnconditionalRequired || hasStaticRequired) && !hasVisibilityRules;
-        const validationConfig = field.validation ? {
+        const baseValidation = field.validation ? {
             ...field.validation,
             required: shouldIncludeRequiredInBase
         } : shouldIncludeRequiredInBase ? {
             required: true
         } : void 0;
-        shape[field.name] = (0, external_validation_converter_cjs_namespaceObject.validationConfigToZod)(validationConfig, field.type, 'custom' === field.type ? field.valueType : void 0);
+        const validationConfig = baseValidation?.required ? {
+            ...baseValidation,
+            messages: {
+                ...baseValidation.messages,
+                required: baseValidation.messages?.required || requiredMessage
+            }
+        } : baseValidation;
+        const fieldTypeSchema = (0, external_validation_converter_cjs_namespaceObject.validationConfigToZod)(validationConfig, field.type, 'custom' === field.type ? field.valueType : void 0);
+        shape[field.name] = field.valueModes ? (0, external_validation_converter_cjs_namespaceObject.modeAwareSchema)(fieldTypeSchema, {
+            codec: (0, external_value_modes_cjs_namespaceObject.resolveCodec)(codecs, field.valueModes),
+            context: (0, external_value_modes_cjs_namespaceObject.codecContext)(field, field.valueModes),
+            required: shouldIncludeRequiredInBase,
+            requiredMessage: field.validation?.messages?.required ?? requiredMessage,
+            validators
+        }) : fieldTypeSchema;
     });
     const baseSchema = v4_namespaceObject.z.object(shape);
     if (0 === dynamicValidationFields.length) return baseSchema;
     return baseSchema.superRefine((data, ctx)=>{
-        const values = data;
-        for (const { name, rules, staticRequired, customRequiredMessage } of dynamicValidationFields){
+        const stored = data;
+        const values = (0, external_value_modes_cjs_namespaceObject.literalValues)(stored, schema, codecs);
+        for (const { field, name, rules, staticRequired, customRequiredMessage } of dynamicValidationFields){
             const isVisible = external_rules_engine_cjs_namespaceObject.RulesEngine.isFieldVisible(rules, values);
             if (!isVisible) continue;
             const ruleResult = external_rules_engine_cjs_namespaceObject.RulesEngine.applyRules(rules, values, {});
             const isRequired = true === ruleResult.required || staticRequired;
             if (isRequired) {
-                if ((0, external_validation_converter_cjs_namespaceObject.isEmptyFieldValue)(values[name])) ctx.addIssue({
+                if ((0, external_value_modes_cjs_namespaceObject.isEmptyModeValue)(stored[name], field, codecs)) ctx.addIssue({
                     code: v4_namespaceObject.z.ZodIssueCode.custom,
-                    message: customRequiredMessage || 'This field is required',
+                    message: customRequiredMessage || requiredMessage,
                     path: [
                         name
                     ]
@@ -636,6 +704,17 @@ function buildZodSchema(schema) {
         }
     });
 }
+function useShallowStable(value) {
+    const ref = (0, external_react_namespaceObject.useRef)(value);
+    if (!shallowEqual(ref.current, value)) ref.current = value;
+    return ref.current;
+}
+function shallowEqual(a, b) {
+    if (a === b) return true;
+    const aKeys = Object.keys(a);
+    const bKeys = Object.keys(b);
+    return aKeys.length === bKeys.length && aKeys.every((key)=>key in b && a[key] === b[key]);
+}
 async function loadInitialData(initialData, _context) {
     if (!initialData) return {};
     return initialData;

package/dist/components/forms/metadata-form.d.ts

@@ -6,6 +6,11 @@ export { useWatch } from 'react-hook-form';
  */
 export interface MetadataFormProps {
     schema: FormSchema;
+    /**
+     * Keep each plugin object stable (a module constant or memoized): a new plugin object rebuilds
+     * the registries, re-renders every field and, when its codecs or validators change, rebuilds the
+     * validation schema. A new array holding the same plugins is fine.
+     */
     plugins?: FormPlugin[];
     onSubmit?: (data: unknown) => void | Promise<void>;
     className?: string;

package/dist/components/forms/metadata-form.js

@@ -9,9 +9,13 @@ import { ScrollableTabsList, Tabs, TabsContent, TabsTrigger } from "../ui/tabs.j
 import { TooltipProvider } from "../ui/tooltip.js";
 import { deepEqual, get } from "../../lib/index.js";
 import { DataFetcher } from "./data-fetcher.js";
+import { buildFieldActionRegistry } from "./field-actions.js";
 import { FormFieldRenderer } from "./field-renderer.js";
+import { buildFormStrings } from "./form-strings.js";
+import { LiteralValueContext } from "./literal-value-context.js";
 import { RulesEngine } from "./rules-engine.js";
-import { isEmptyFieldValue, validationConfigToZod } from "./validation-converter.js";
+import { modeAwareSchema, validationConfigToZod } from "./validation-converter.js";
+import { buildValueModeRegistry, codecContext, isEmptyModeValue, literalValueOf, literalValues, resolveCodec } from "./value-modes.js";
 const DEFAULT_PLUGINS = [];
 function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className, disabled = false, autoComplete, stepVariant = 'wizard', sectionVariant = 'card', activeStepId, onActiveStepChange, container = 'form' }) {
     const [currentStep, setCurrentStep] = useState(0);
@@ -30,12 +34,41 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
             ...stableSchema.sections ?? [],
             ...(stableSchema.steps ?? []).flatMap((step)=>step.sections)
         ];
-        return sections.some((section)=>section.fields.some((field)=>void 0 !== field.tooltip));
+        return sections.some((section)=>section.fields.some((field)=>void 0 !== field.tooltip || void 0 !== field.valueModes || !!field.headerActions));
     }, [
         stableSchema
     ]);
-    const zodSchema = useMemo(()=>buildZodSchema(stableSchema), [
-        stableSchema
+    const stablePlugins = useShallowStable(plugins);
+    const valueModeRegistry = useMemo(()=>buildValueModeRegistry(stablePlugins), [
+        stablePlugins
+    ]);
+    const fieldActionRegistry = useMemo(()=>buildFieldActionRegistry(stablePlugins), [
+        stablePlugins
+    ]);
+    const formStrings = useMemo(()=>buildFormStrings(stablePlugins), [
+        stablePlugins
+    ]);
+    const readLiteralValue = useCallback((name, stored)=>literalValueOf(name, stored, stableSchema, valueModeRegistry.codecs), [
+        stableSchema,
+        valueModeRegistry
+    ]);
+    const formVariables = useMemo(()=>[
+            ...stablePlugins
+        ].reverse().find((plugin)=>plugin.variables)?.variables, [
+        stablePlugins
+    ]);
+    const codecs = useShallowStable(valueModeRegistry.codecs);
+    const validators = useShallowStable(modeValidators(valueModeRegistry));
+    const requiredMessage = formStrings.validation.required;
+    const zodSchema = useMemo(()=>buildZodSchema(stableSchema, {
+            codecs,
+            validators,
+            requiredMessage
+        }), [
+        stableSchema,
+        codecs,
+        validators,
+        requiredMessage
     ]);
     const form = useForm({
         resolver: standardSchemaResolver(zodSchema),
@@ -49,7 +82,9 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     pluginsRef.current = plugins;
     const onSubmitRef = useRef(onSubmit);
     onSubmitRef.current = onSubmit;
-    const context = useMemo(()=>({
+    const context = useMemo(()=>{
+        const readValues = (values)=>literalValues(values, stableSchema, valueModeRegistry.codecs);
+        return {
             schema: stableSchema,
             form,
             get values () {
@@ -65,9 +100,9 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
                 return form.formState.isDirty;
             },
             currentStep: stableSchema.steps ? currentStep : void 0,
-            evaluateConditions: (conditions)=>RulesEngine.evaluateConditions(conditions, valuesRef.current, 'AND'),
+            evaluateConditions: (conditions)=>RulesEngine.evaluateConditions(conditions, readValues(valuesRef.current), 'AND'),
             fetchData: async (source)=>{
-                const result = await DataFetcher.fetch(source, valuesRef.current);
+                const result = await DataFetcher.fetch(source, readValues(valuesRef.current));
                 return result;
             },
             registerCustomComponent: (name, component)=>{
@@ -75,11 +110,20 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
                         ...prev,
                         [name]: component
                     }));
-            }
-        }), [
+            },
+            valueModes: valueModeRegistry,
+            fieldActions: fieldActionRegistry,
+            strings: formStrings,
+            variables: formVariables
+        };
+    }, [
         stableSchema,
         form,
-        currentStep
+        currentStep,
+        valueModeRegistry,
+        fieldActionRegistry,
+        formStrings,
+        formVariables
     ]);
     const contextRef = useRef(context);
     contextRef.current = context;
@@ -131,13 +175,13 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     ]);
     const allCustomComponents = useMemo(()=>{
         const fromPlugins = {};
-        for (const plugin of plugins)Object.assign(fromPlugins, plugin.components);
+        for (const plugin of stablePlugins)Object.assign(fromPlugins, plugin.components);
         return {
             ...fromPlugins,
             ...customComponents
         };
     }, [
-        plugins,
+        stablePlugins,
         customComponents
     ]);
     const enterSwallowRef = useRef(null);
@@ -209,9 +253,12 @@ function MetadataForm({ schema, plugins = DEFAULT_PLUGINS, onSubmit, className,
     });
     return /*#__PURE__*/ jsx(FormProvider, {
         ...form,
-        children: hasFieldTooltip ? /*#__PURE__*/ jsx(TooltipProvider, {
-            children: body
-        }) : body
+        children: /*#__PURE__*/ jsx(LiteralValueContext.Provider, {
+            value: readLiteralValue,
+            children: hasFieldTooltip ? /*#__PURE__*/ jsx(TooltipProvider, {
+                children: body
+            }) : body
+        })
     });
 }
 function conditionDependencies(conditionGroups) {
@@ -551,7 +598,12 @@ const metadata_form_FormActions = /*#__PURE__*/ react.memo(function({ schema, co
         })
     });
 });
-function buildZodSchema(schema) {
+function modeValidators(registry) {
+    const validators = {};
+    for (const [mode, definition] of Object.entries(registry.definitions))if (definition?.validate) validators[mode] = definition.validate;
+    return validators;
+}
+function buildZodSchema(schema, { codecs, validators, requiredMessage }) {
     const shape = {};
     const fields = schema.steps ? schema.steps.flatMap((step)=>step.sections.flatMap((s)=>s.fields)) : schema.sections?.flatMap((s)=>s.fields) || [];
     const dynamicValidationFields = [];
@@ -562,33 +614,49 @@ function buildZodSchema(schema) {
         const hasStaticRequired = field.validation?.required === true;
         const hasAnyRequired = hasStaticRequired || hasUnconditionalRequired || hasConditionalRequired;
         if (field.rules && (hasConditionalRequired || hasAnyRequired && hasVisibilityRules)) dynamicValidationFields.push({
+            field,
             name: field.name,
             rules: field.rules,
             staticRequired: hasStaticRequired || hasUnconditionalRequired || false,
             customRequiredMessage: field.validation?.messages?.required
         });
         const shouldIncludeRequiredInBase = (hasUnconditionalRequired || hasStaticRequired) && !hasVisibilityRules;
-        const validationConfig = field.validation ? {
+        const baseValidation = field.validation ? {
             ...field.validation,
             required: shouldIncludeRequiredInBase
         } : shouldIncludeRequiredInBase ? {
             required: true
         } : void 0;
-        shape[field.name] = validationConfigToZod(validationConfig, field.type, 'custom' === field.type ? field.valueType : void 0);
+        const validationConfig = baseValidation?.required ? {
+            ...baseValidation,
+            messages: {
+                ...baseValidation.messages,
+                required: baseValidation.messages?.required || requiredMessage
+            }
+        } : baseValidation;
+        const fieldTypeSchema = validationConfigToZod(validationConfig, field.type, 'custom' === field.type ? field.valueType : void 0);
+        shape[field.name] = field.valueModes ? modeAwareSchema(fieldTypeSchema, {
+            codec: resolveCodec(codecs, field.valueModes),
+            context: codecContext(field, field.valueModes),
+            required: shouldIncludeRequiredInBase,
+            requiredMessage: field.validation?.messages?.required ?? requiredMessage,
+            validators
+        }) : fieldTypeSchema;
     });
     const baseSchema = z.object(shape);
     if (0 === dynamicValidationFields.length) return baseSchema;
     return baseSchema.superRefine((data, ctx)=>{
-        const values = data;
-        for (const { name, rules, staticRequired, customRequiredMessage } of dynamicValidationFields){
+        const stored = data;
+        const values = literalValues(stored, schema, codecs);
+        for (const { field, name, rules, staticRequired, customRequiredMessage } of dynamicValidationFields){
             const isVisible = RulesEngine.isFieldVisible(rules, values);
             if (!isVisible) continue;
             const ruleResult = RulesEngine.applyRules(rules, values, {});
             const isRequired = true === ruleResult.required || staticRequired;
             if (isRequired) {
-                if (isEmptyFieldValue(values[name])) ctx.addIssue({
+                if (isEmptyModeValue(stored[name], field, codecs)) ctx.addIssue({
                     code: z.ZodIssueCode.custom,
-                    message: customRequiredMessage || 'This field is required',
+                    message: customRequiredMessage || requiredMessage,
                     path: [
                         name
                     ]
@@ -597,6 +665,17 @@ function buildZodSchema(schema) {
         }
     });
 }
+function useShallowStable(value) {
+    const ref = useRef(value);
+    if (!shallowEqual(ref.current, value)) ref.current = value;
+    return ref.current;
+}
+function shallowEqual(a, b) {
+    if (a === b) return true;
+    const aKeys = Object.keys(a);
+    const bKeys = Object.keys(b);
+    return aKeys.length === bKeys.length && aKeys.every((key)=>key in b && a[key] === b[key]);
+}
 async function loadInitialData(initialData, _context) {
     if (!initialData) return {};
     return initialData;