@react-typed-forms/schemas 10.2.0 → 10.4.0

package/lib/controlRender.d.ts

@@ -117,6 +117,7 @@ export interface DataRendererProps extends ParentRendererProps {
 export interface ActionRendererProps {
     actionId: string;
     actionText: string;
+    actionData?: any;
     onClick: () => void;
     className?: string;
     style?: React.CSSProperties;
@@ -146,6 +147,7 @@ export interface DataControlProps {
 export type CreateDataProps = (controlProps: DataControlProps) => DataRendererProps;
 export interface ControlRenderOptions extends FormContextOptions {
     useDataHook?: (c: ControlDefinition) => CreateDataProps;
+    actionOnClick?: (actionId: string, actionData: any) => () => void;
     useEvalExpressionHook?: UseEvalExpressionHook;
     clearHidden?: boolean;
     schemaInterface?: SchemaInterface;
@@ -184,7 +186,9 @@ export interface RenderControlProps {
     displayControl?: Control<string | undefined>;
     style?: React.CSSProperties;
     allowedOptions?: Control<any[] | undefined>;
+    actionDataControl?: Control<any | undefined | null>;
     useChildVisibility: ChildVisibilityFunc;
+    actionOnClick?: (actionId: string, actionData: any) => () => void;
 }
 export declare function renderControlLayout(props: RenderControlProps): ControlLayoutProps;
 export declare function appendMarkup(k: keyof Omit<RenderedLayout, "errorControl" | "style" | "className">, markup: ReactNode): (layout: RenderedLayout) => void;

package/lib/hooks.d.ts

@@ -18,4 +18,5 @@ export declare function useEvalDynamicHook(definition: ControlDefinition, type:
 export declare function matchesType(context: ControlDataContext, types?: string[] | null): boolean | undefined;
 export declare function hideDisplayOnly(context: ControlDataContext, field: SchemaField, definition: ControlDefinition, schemaInterface: SchemaInterface): boolean | undefined;
 export declare function useJsonataExpression(jExpr: string, dataContext: DataContext, bindings?: () => Record<string, any>): Control<any>;
+export declare function useEvalActionHook(useExpr: UseEvalExpressionHook, definition: ControlDefinition): EvalExpressionHook<string | null>;
 export declare function useEvalLabelText(useExpr: UseEvalExpressionHook, definition: ControlDefinition): EvalExpressionHook<string | null>;

package/lib/index.js

@@ -41,6 +41,7 @@ exports.DynamicPropertyType = void 0;
   DynamicPropertyType["LayoutStyle"] = "LayoutStyle";
   DynamicPropertyType["AllowedOptions"] = "AllowedOptions";
   DynamicPropertyType["Label"] = "Label";
+  DynamicPropertyType["ActionData"] = "ActionData";
 })(exports.DynamicPropertyType || (exports.DynamicPropertyType = {}));
 exports.ExpressionType = void 0;
 (function (ExpressionType) {
@@ -313,49 +314,100 @@ function defaultControlForField(sf) {
   }
   throw "Unknown schema field";
 }
-function findReferencedControl(field, control) {
-  if (isDataControl(control) && field === control.field) return control;
-  if (isGroupControl(control)) {
-    var _control$children;
-    if (control.compoundField) return field === control.compoundField ? control : undefined;
-    return findReferencedControlInArray(field, (_control$children = control.children) != null ? _control$children : []);
+function findControlsForCompound(compound, definition) {
+  if (isDataControlDefinition(definition) && compound.field === definition.field) {
+    return [definition];
   }
-  return undefined;
+  if (isGroupControlsDefinition(definition)) {
+    var _definition$children$, _definition$children;
+    if (definition.compoundField === compound.field) return [definition];
+    return (_definition$children$ = (_definition$children = definition.children) == null ? void 0 : _definition$children.flatMap(function (d) {
+      return findControlsForCompound(compound, d);
+    })) != null ? _definition$children$ : [];
+  }
+  return [];
 }
-function findReferencedControlInArray(field, controls) {
-  for (var _iterator = _createForOfIteratorHelperLoose(controls), _step; !(_step = _iterator()).done;) {
-    var c = _step.value;
-    var ref = findReferencedControl(field, c);
-    if (ref) return ref;
+function findCompoundGroups(fields, controls) {
+  return Object.fromEntries(fields.filter(isCompoundField).map(function (cf) {
+    var groups = controls.flatMap(function (x) {
+      return findControlsForCompound(cf, x);
+    });
+    return [cf.field, {
+      groups: groups.concat(findNonDataGroups(groups.flatMap(function (x) {
+        var _x$children;
+        return (_x$children = x.children) != null ? _x$children : [];
+      }))),
+      children: findCompoundGroups(cf.children, groups.flatMap(function (x) {
+        var _x$children2;
+        return (_x$children2 = x.children) != null ? _x$children2 : [];
+      }))
+    }];
+  }));
+}
+function existsInGroups(field, lookup) {
+  var itself = lookup.groups.find(function (c) {
+    var _c$children;
+    return (_c$children = c.children) == null ? void 0 : _c$children.find(function (x) {
+      return isDataControlDefinition(x) && x.field === field.field || isGroupControlsDefinition(x) && x.compoundField === field.field;
+    });
+  });
+  if (!itself) return [[field, lookup]];
+  if (isCompoundField(field)) {
+    var childLookup = lookup.children[field.field];
+    if (!childLookup) return [[field, lookup]];
+    return field.children.flatMap(function (c) {
+      return existsInGroups(c, childLookup);
+    });
   }
-  return undefined;
+  return [];
+}
+function findNonDataGroups(controls) {
+  return controls.flatMap(function (control) {
+    var _control$children2;
+    return isGroupControlsDefinition(control) && !control.compoundField ? [control].concat(findNonDataGroups((_control$children2 = control.children) != null ? _control$children2 : [])) : [];
+  });
+}
+function cloneChildren(c) {
+  var _c$children2;
+  if (c.children) return _extends({}, c, {
+    children: (_c$children2 = c.children) == null ? void 0 : _c$children2.map(cloneChildren)
+  });
+  return c;
 }
 function addMissingControls(fields, controls) {
-  var changes = fields.flatMap(function (x) {
-    if (fieldHasTag(x, "_NoControl")) return [];
-    var existing = findReferencedControlInArray(x.field, controls);
-    if (!existing || isCompoundField(x)) return {
-      field: x,
-      existing: existing
-    };
-    return [];
+  controls = controls.map(cloneChildren);
+  var rootMapping = findCompoundGroups(fields, controls);
+  var rootGroups = findNonDataGroups([{
+    type: exports.ControlDefinitionType.Group,
+    children: controls
+  }]);
+  var rootLookup = {
+    children: rootMapping,
+    groups: rootGroups
+  };
+  var missingFields = fields.filter(function (x) {
+    return !fieldHasTag(x, "_NoControl");
+  }).flatMap(function (x) {
+    return existsInGroups(x, rootLookup);
   });
-  var changedCompounds = controls.map(function (x) {
-    var _cf$children;
-    var ex = changes.find(function (c) {
-      return c.existing === x;
-    });
-    if (!ex) return x;
-    var cf = x;
-    return _extends({}, cf, {
-      children: addMissingControls(ex.field.children, (_cf$children = cf.children) != null ? _cf$children : [])
+  missingFields.forEach(function (_ref) {
+    var _f$tags, _insertGroup;
+    var f = _ref[0],
+      lookup = _ref[1];
+    var groupToAdd = (_f$tags = f.tags) == null ? void 0 : _f$tags.find(function (x) {
+      return x.startsWith("_ControlGroup:");
     });
+    var insertGroup = undefined;
+    if (groupToAdd) {
+      var groupName = groupToAdd.substring(14);
+      insertGroup = lookup.groups.find(function (x) {
+        return x.title === groupName;
+      });
+    }
+    if (!insertGroup) insertGroup = lookup.groups[0];
+    (_insertGroup = insertGroup) == null || (_insertGroup = _insertGroup.children) == null || _insertGroup.push(defaultControlForField(f));
   });
-  return changedCompounds.concat(changes.filter(function (x) {
-    return !x.existing;
-  }).map(function (x) {
-    return defaultControlForField(x.field);
-  }));
+  return controls;
 }
 function useUpdatedRef(a) {
   var r = React.useRef(a);
@@ -472,8 +524,8 @@ function cleanDataForSchema(v, fields) {
   return out;
 }
 function getAllReferencedClasses(c, collectExtra) {
-  var _c$children, _collectExtra;
-  var childClasses = (_c$children = c.children) == null ? void 0 : _c$children.flatMap(function (x) {
+  var _c$children3, _collectExtra;
+  var childClasses = (_c$children3 = c.children) == null ? void 0 : _c$children3.flatMap(function (x) {
     return getAllReferencedClasses(x, collectExtra);
   });
   var tc = clsx__default["default"]([c.styleClass, c.layoutClass, c.labelClass].concat((_collectExtra = collectExtra == null ? void 0 : collectExtra(c)) != null ? _collectExtra : []).map(getOverrideClass));
@@ -543,8 +595,8 @@ function makeHook(runHook, state, deps) {
 }
 function useDynamicHooks(hooks) {
   var hookEntries = Object.entries(hooks);
-  var deps = hookEntries.map(function (_ref) {
-    var x = _ref[1];
+  var deps = hookEntries.map(function (_ref2) {
+    var x = _ref2[1];
     return toDepString(x.deps);
   }).join(",");
   var ref = React.useRef({});
@@ -553,9 +605,9 @@ function useDynamicHooks(hooks) {
     return s[x[0]] = x[1].state;
   });
   return React.useCallback(function (p) {
-    return Object.fromEntries(hookEntries.map(function (_ref2) {
-      var f = _ref2[0],
-        hg = _ref2[1];
+    return Object.fromEntries(hookEntries.map(function (_ref3) {
+      var f = _ref3[0],
+        hg = _ref3[1];
       return [f, hg.runHook(p, ref.current[f])];
     }));
   }, [deps]);
@@ -1056,6 +1108,12 @@ function useJsonataExpression(jExpr, dataContext, bindings) {
   }, [compiledExpr]);
   return control;
 }
+function useEvalActionHook(useExpr, definition) {
+  var dynamicValue = useEvalDynamicHook(definition, exports.DynamicPropertyType.ActionData, useExpr);
+  return makeDynamicPropertyHook(dynamicValue, function () {
+    return core.useControl(null);
+  }, undefined);
+}
 function useEvalLabelText(useExpr, definition) {
   var dynamicValue = useEvalDynamicHook(definition, exports.DynamicPropertyType.Label, useExpr);
   return makeDynamicPropertyHook(dynamicValue, function () {
@@ -1225,6 +1283,7 @@ function useControlRenderer(definition, fields, renderer, options) {
     disabledControl: useEvalDisabledHook(useExpr, definition),
     allowedOptions: useEvalAllowedOptionsHook(useExpr, definition),
     labelText: useEvalLabelText(useExpr, definition),
+    actionData: useEvalActionHook(useExpr, definition),
     customStyle: useEvalStyleHook(useExpr, exports.DynamicPropertyType.Style, definition),
     layoutStyle: useEvalStyleHook(useExpr, exports.DynamicPropertyType.LayoutStyle, definition),
     displayControl: useEvalDisplayHook(useExpr, definition)
@@ -1265,7 +1324,8 @@ function useControlRenderer(definition, fields, renderer, options) {
         labelText = _dynamicHooks.labelText,
         customStyle = _dynamicHooks.customStyle,
         allowedOptions = _dynamicHooks.allowedOptions,
-        defaultValueControl = _dynamicHooks.defaultValueControl;
+        defaultValueControl = _dynamicHooks.defaultValueControl,
+        actionData = _dynamicHooks.actionData;
       var visible = visibleControl.current.value;
       var visibility = core.useControl(function () {
         return visible != null ? {
@@ -1359,6 +1419,8 @@ function useControlRenderer(definition, fields, renderer, options) {
         displayControl: displayControl,
         style: customStyle.value,
         allowedOptions: allowedOptions,
+        actionDataControl: actionData,
+        actionOnClick: _options.actionOnClick,
         useChildVisibility: function useChildVisibility(childDef, context) {
           var schemaField = lookupSchemaField(childDef, (context != null ? context : controlDataContext).fields);
           return useEvalVisibilityHook(useExpr, childDef, schemaField);
@@ -1542,12 +1604,14 @@ function renderControlLayout(props) {
     };
   }
   if (isActionControlsDefinition(c)) {
-    var _ref5, _labelText$value2;
+    var _props$actionDataCont, _props$actionDataCont2, _ref5, _labelText$value2, _props$actionOnClick;
+    var actionData = (_props$actionDataCont = (_props$actionDataCont2 = props.actionDataControl) == null ? void 0 : _props$actionDataCont2.value) != null ? _props$actionDataCont : c.actionData;
     return {
       children: renderer.renderAction({
         actionText: (_ref5 = (_labelText$value2 = labelText == null ? void 0 : labelText.value) != null ? _labelText$value2 : c.title) != null ? _ref5 : c.actionId,
         actionId: c.actionId,
-        onClick: function onClick() {},
+        actionData: actionData,
+        onClick: (_props$actionOnClick = props.actionOnClick == null ? void 0 : props.actionOnClick(c.actionId, actionData)) != null ? _props$actionOnClick : function () {},
         className: cc(c.styleClass),
         style: style
       })
@@ -2504,7 +2568,7 @@ function createFormRenderer(customRenderers, defaultRenderers) {
     var options = hasOptions(props);
     var renderer = (_dataRegistrations$fi = dataRegistrations.find(function (x) {
       var _x$collection, _field$collection, _x$options;
-      return ((_x$collection = x.collection) != null ? _x$collection : false) === (props.elementIndex == null && ((_field$collection = field.collection) != null ? _field$collection : false)) && ((_x$options = x.options) != null ? _x$options : false) === options && (x.schemaType && isOneOf(x.schemaType, field.type) || x.renderType && isOneOf(x.renderType, renderType) || x.match && x.match(props));
+      return ((_x$collection = x.collection) != null ? _x$collection : false) === (props.elementIndex == null && ((_field$collection = field.collection) != null ? _field$collection : false)) && ((_x$options = x.options) != null ? _x$options : false) === options && (x.schemaType && renderType == exports.DataRenderType.Standard && isOneOf(x.schemaType, field.type) || x.renderType && isOneOf(x.renderType, renderType) || x.match && x.match(props));
     })) != null ? _dataRegistrations$fi : defaultRenderers.data;
     var result = renderer.render(props, formRenderers);
     if (typeof result === "function") return result;
@@ -2670,12 +2734,16 @@ exports.dynamicReadonly = dynamicReadonly;
 exports.dynamicVisibility = dynamicVisibility;
 exports.elementValueForField = elementValueForField;
 exports.emptyGroupDefinition = emptyGroupDefinition;
+exports.existsInGroups = existsInGroups;
 exports.fieldDisplayName = fieldDisplayName;
 exports.fieldEqExpr = fieldEqExpr;
 exports.fieldHasTag = fieldHasTag;
 exports.findChildDefinition = findChildDefinition;
 exports.findCompoundField = findCompoundField;
+exports.findCompoundGroups = findCompoundGroups;
+exports.findControlsForCompound = findControlsForCompound;
 exports.findField = findField;
+exports.findNonDataGroups = findNonDataGroups;
 exports.findScalarField = findScalarField;
 exports.getAllReferencedClasses = getAllReferencedClasses;
 exports.getControlData = getControlData;
@@ -2726,6 +2794,7 @@ exports.toDepString = toDepString;
 exports.useControlDefinitionForSchema = useControlDefinitionForSchema;
 exports.useControlRenderer = useControlRenderer;
 exports.useDynamicHooks = useDynamicHooks;
+exports.useEvalActionHook = useEvalActionHook;
 exports.useEvalAllowedOptionsHook = useEvalAllowedOptionsHook;
 exports.useEvalDefaultValueHook = useEvalDefaultValueHook;
 exports.useEvalDisabledHook = useEvalDisabledHook;