feat: add config to ValidateFunctionContext (#2483)

Allows to access the config in custom validators

Author: kchobantonov

packages/angular-material/src/library/layouts/categorization-layout.renderer.ts

@@ -30,6 +30,7 @@ import {
   defaultJsonFormsI18nState,
   deriveLabelForUISchemaElement,
   getAjv,
+  getConfig,
   isVisible,
   JsonFormsState,
   Labelable,
@@ -87,7 +88,13 @@ export class CategorizationTabLayoutRenderer
           this.hidden = !props.visible;
           this.visibleCategories = this.uischema.elements.filter(
             (category: Category | Categorization) =>
-              isVisible(category, props.data, undefined, getAjv(state))
+              isVisible(
+                category,
+                props.data,
+                undefined,
+                getAjv(state),
+                getConfig(state)
+              )
           );
           this.categoryLabels = this.visibleCategories.map((element) =>
             deriveLabelForUISchemaElement(

packages/angular-material/src/library/other/util.ts

@@ -25,6 +25,7 @@
 import {
   ControlElement,
   getAjv,
+  getConfig,
   getData,
   isVisible,
   JsonFormsState,
@@ -44,7 +45,13 @@ export const mapStateToVisible = (
   const visible =
     ownProps.visible !== undefined
       ? ownProps.visible
-      : isVisible(ownProps.uischema, getData(state), undefined, getAjv(state));
+      : isVisible(
+          ownProps.uischema,
+          getData(state),
+          undefined,
+          getAjv(state),
+          getConfig(state)
+        );
 
   return {
     visible,

packages/core/src/mappers/cell.ts

@@ -112,13 +112,13 @@ export const mapStateToCellProps = (
 ): StatePropsOfCell => {
   const { id, schema, path, uischema, renderers, cells } = ownProps;
   const rootData = getData(state);
+  const config = getConfig(state);
   const visible =
     ownProps.visible !== undefined
       ? ownProps.visible
-      : isVisible(uischema, rootData, undefined, getAjv(state));
+      : isVisible(uischema, rootData, undefined, getAjv(state), config);
 
   const rootSchema = getSchema(state);
-  const config = getConfig(state);
 
   /* When determining the enabled state of cells we take a shortcut: At the
    * moment it's only possible to configure enablement and disablement at the

packages/core/src/mappers/renderer.ts

@@ -582,9 +582,11 @@ export const mapStateToControlProps = (
   const { uischema } = ownProps;
   const rootData = getData(state);
   const path = composeWithUi(uischema, ownProps.path);
+  const config = getConfig(state);
+
   const visible: boolean =
     ownProps.visible === undefined || hasShowRule(uischema)
-      ? isVisible(uischema, rootData, ownProps.path, getAjv(state))
+      ? isVisible(uischema, rootData, ownProps.path, getAjv(state), config)
       : ownProps.visible;
   const controlElement = uischema as ControlElement;
   const id = ownProps.id;
@@ -604,7 +606,6 @@ export const mapStateToControlProps = (
   const data = Resolve.data(rootData, path);
   const labelDesc = createLabelDescriptionFrom(uischema, resolvedSchema);
   const label = labelDesc.show ? labelDesc.text : '';
-  const config = getConfig(state);
   const enabled: boolean = isInherentlyEnabled(
     state,
     ownProps,
@@ -1042,7 +1043,13 @@ export const mapStateToLayoutProps = (
   const { uischema } = ownProps;
   const visible: boolean =
     ownProps.visible === undefined || hasShowRule(uischema)
-      ? isVisible(ownProps.uischema, rootData, ownProps.path, getAjv(state))
+      ? isVisible(
+          ownProps.uischema,
+          rootData,
+          ownProps.path,
+          getAjv(state),
+          getConfig(state)
+        )
       : ownProps.visible;
 
   const data = Resolve.data(rootData, ownProps.path);
@@ -1280,7 +1287,13 @@ export const mapStateToLabelProps = (
 
   const visible: boolean =
     props.visible === undefined || hasShowRule(uischema)
-      ? isVisible(props.uischema, getData(state), props.path, getAjv(state))
+      ? isVisible(
+          props.uischema,
+          getData(state),
+          props.path,
+          getAjv(state),
+          getConfig(state)
+        )
       : props.visible;
 
   const text = uischema.text;

packages/core/src/mappers/util.ts

@@ -19,7 +19,7 @@ export const isInherentlyEnabled = (
     return false;
   }
   if (uischema && hasEnableRule(uischema)) {
-    return isEnabled(uischema, rootData, ownProps?.path, getAjv(state));
+    return isEnabled(uischema, rootData, ownProps?.path, getAjv(state), config);
   }
   if (typeof uischema?.options?.readonly === 'boolean') {
     return !uischema.options.readonly;

packages/core/src/models/uischema.ts

@@ -169,6 +169,8 @@ export interface ValidateFunctionContext {
   path: string | undefined;
   /** The `UISchemaElement` containing the rule that uses the ValidateFunctionCondition, e.g. a `ControlElement` */
   uischemaElement: UISchemaElement;
+  /** The form config */
+  config: unknown;
 }
 
 /**

packages/core/src/util/runtime.ts

@@ -67,16 +67,19 @@ const evaluateCondition = (
   uischema: UISchemaElement,
   condition: Condition,
   path: string,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
   if (isAndCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc && evaluateCondition(data, uischema, cur, path, ajv),
+      (acc, cur) =>
+        acc && evaluateCondition(data, uischema, cur, path, ajv, config),
       true
     );
   } else if (isOrCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc || evaluateCondition(data, uischema, cur, path, ajv),
+      (acc, cur) =>
+        acc || evaluateCondition(data, uischema, cur, path, ajv, config),
       false
     );
   } else if (isLeafCondition(condition)) {
@@ -95,6 +98,7 @@ const evaluateCondition = (
       fullData: data,
       path,
       uischemaElement: uischema,
+      config,
     };
     return condition.validate(context);
   } else {
@@ -107,19 +111,21 @@ const isRuleFulfilled = (
   uischema: UISchemaElement,
   data: any,
   path: string,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
   const condition = uischema.rule.condition;
-  return evaluateCondition(data, uischema, condition, path, ajv);
+  return evaluateCondition(data, uischema, condition, path, ajv, config);
 };
 
 export const evalVisibility = (
   uischema: UISchemaElement,
   data: any,
   path: string = undefined,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
-  const fulfilled = isRuleFulfilled(uischema, data, path, ajv);
+  const fulfilled = isRuleFulfilled(uischema, data, path, ajv, config);
 
   switch (uischema.rule.effect) {
     case RuleEffect.HIDE:
@@ -136,9 +142,10 @@ export const evalEnablement = (
   uischema: UISchemaElement,
   data: any,
   path: string = undefined,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
-  const fulfilled = isRuleFulfilled(uischema, data, path, ajv);
+  const fulfilled = isRuleFulfilled(uischema, data, path, ajv, config);
 
   switch (uischema.rule.effect) {
     case RuleEffect.DISABLE:
@@ -177,10 +184,11 @@ export const isVisible = (
   uischema: UISchemaElement,
   data: any,
   path: string = undefined,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
   if (uischema.rule) {
-    return evalVisibility(uischema, data, path, ajv);
+    return evalVisibility(uischema, data, path, ajv, config);
   }
 
   return true;
@@ -190,10 +198,11 @@ export const isEnabled = (
   uischema: UISchemaElement,
   data: any,
   path: string = undefined,
-  ajv: Ajv
+  ajv: Ajv,
+  config: unknown
 ): boolean => {
   if (uischema.rule) {
-    return evalEnablement(uischema, data, path, ajv);
+    return evalEnablement(uischema, data, path, ajv, config);
   }
 
   return true;

packages/core/src/util/util.ts

@@ -163,10 +163,20 @@ export const Paths = {
 
 // Runtime --
 export const Runtime = {
-  isEnabled(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
-    return isEnabled(uischema, data, undefined, ajv);
+  isEnabled(
+    uischema: UISchemaElement,
+    data: any,
+    ajv: Ajv,
+    config: unknown
+  ): boolean {
+    return isEnabled(uischema, data, undefined, ajv, config);
   },
-  isVisible(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
-    return isVisible(uischema, data, undefined, ajv);
+  isVisible(
+    uischema: UISchemaElement,
+    data: any,
+    ajv: Ajv,
+    config: unknown
+  ): boolean {
+    return isVisible(uischema, data, undefined, ajv, config);
   },
 };