@jsonforms/core 3.6.0-alpha.1 → 3.6.0

package/lib/models/uischema.d.ts

@@ -106,6 +106,25 @@ export interface SchemaBasedCondition extends BaseCondition, Scoped {
      */
     failWhenUndefined?: boolean;
 }
+/** A condition using a validation function to determine its fulfillment. */
+export interface ValidateFunctionCondition extends BaseCondition, Scoped {
+    /**
+     * Validates whether the condition is fulfilled.
+     *
+     * @param data The data as resolved via the scope.
+     * @returns `true` if the condition is fulfilled */
+    validate: (context: ValidateFunctionContext) => boolean;
+}
+export interface ValidateFunctionContext {
+    /** The resolved data scoped to the `ValidateFunctionCondition`'s scope. */
+    data: unknown;
+    /** The full data of the form. */
+    fullData: unknown;
+    /** Optional instance path. Necessary when the actual data path can not be inferred via the scope alone as it is the case with nested controls. */
+    path: string | undefined;
+    /** The `UISchemaElement` containing the rule that uses the ValidateFunctionCondition, e.g. a `ControlElement` */
+    uischemaElement: UISchemaElement;
+}
 /**
  * A composable condition.
  */
@@ -127,7 +146,7 @@ export interface AndCondition extends ComposableCondition {
 /**
  * A union of all available conditions.
  */
-export type Condition = BaseCondition | LeafCondition | OrCondition | AndCondition | SchemaBasedCondition;
+export type Condition = BaseCondition | LeafCondition | OrCondition | AndCondition | SchemaBasedCondition | ValidateFunctionCondition;
 /**
  * Common base interface for any UI schema element.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.6.0-alpha.1",
+  "version": "3.6.0",
   "description": "Core module of JSON Forms",
   "repository": "https://github.com/eclipsesource/jsonforms",
   "bugs": "https://github.com/eclipsesource/jsonforms/issues",

package/src/models/uischema.ts

@@ -150,6 +150,27 @@ export interface SchemaBasedCondition extends BaseCondition, Scoped {
   failWhenUndefined?: boolean;
 }
 
+/** A condition using a validation function to determine its fulfillment. */
+export interface ValidateFunctionCondition extends BaseCondition, Scoped {
+  /**
+   * Validates whether the condition is fulfilled.
+   *
+   * @param data The data as resolved via the scope.
+   * @returns `true` if the condition is fulfilled */
+  validate: (context: ValidateFunctionContext) => boolean;
+}
+
+export interface ValidateFunctionContext {
+  /** The resolved data scoped to the `ValidateFunctionCondition`'s scope. */
+  data: unknown;
+  /** The full data of the form. */
+  fullData: unknown;
+  /** Optional instance path. Necessary when the actual data path can not be inferred via the scope alone as it is the case with nested controls. */
+  path: string | undefined;
+  /** The `UISchemaElement` containing the rule that uses the ValidateFunctionCondition, e.g. a `ControlElement` */
+  uischemaElement: UISchemaElement;
+}
+
 /**
  * A composable condition.
  */
@@ -179,7 +200,8 @@ export type Condition =
   | LeafCondition
   | OrCondition
   | AndCondition
-  | SchemaBasedCondition;
+  | SchemaBasedCondition
+  | ValidateFunctionCondition;
 
 /**
  * Common base interface for any UI schema element.

package/src/util/resolvers.ts

@@ -123,12 +123,8 @@ const resolveSchemaWithSegments = (
   pathSegments: string[],
   rootSchema: JsonSchema
 ): JsonSchema => {
-  if (isEmpty(schema)) {
-    return undefined;
-  }
-
   // use typeof because schema can by of any type - check singleSegmentResolveSchema below
-  if (typeof schema.$ref === 'string') {
+  if (typeof schema?.$ref === 'string') {
     schema = resolveSchema(rootSchema, schema.$ref, rootSchema);
   }
 
@@ -136,6 +132,10 @@ const resolveSchemaWithSegments = (
     return schema;
   }
 
+  if (isEmpty(schema)) {
+    return undefined;
+  }
+
   const [segment, ...remainingSegments] = pathSegments;
 
   if (invalidSegment(segment)) {

package/src/util/runtime.ts

@@ -33,6 +33,7 @@ import {
   SchemaBasedCondition,
   Scopable,
   UISchemaElement,
+  ValidateFunctionCondition,
 } from '../models';
 import { resolveData } from './resolvers';
 import type Ajv from 'ajv';
@@ -51,24 +52,31 @@ const isSchemaCondition = (
   condition: Condition
 ): condition is SchemaBasedCondition => has(condition, 'schema');
 
+const isValidateFunctionCondition = (
+  condition: Condition
+): condition is ValidateFunctionCondition =>
+  has(condition, 'validate') &&
+  typeof (condition as ValidateFunctionCondition).validate === 'function';
+
 const getConditionScope = (condition: Scopable, path: string): string => {
   return composeWithUi(condition, path);
 };
 
 const evaluateCondition = (
   data: any,
+  uischema: UISchemaElement,
   condition: Condition,
   path: string,
   ajv: Ajv
 ): boolean => {
   if (isAndCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc && evaluateCondition(data, cur, path, ajv),
+      (acc, cur) => acc && evaluateCondition(data, uischema, cur, path, ajv),
       true
     );
   } else if (isOrCondition(condition)) {
     return condition.conditions.reduce(
-      (acc, cur) => acc || evaluateCondition(data, cur, path, ajv),
+      (acc, cur) => acc || evaluateCondition(data, uischema, cur, path, ajv),
       false
     );
   } else if (isLeafCondition(condition)) {
@@ -80,6 +88,15 @@ const evaluateCondition = (
       return false;
     }
     return ajv.validate(condition.schema, value) as boolean;
+  } else if (isValidateFunctionCondition(condition)) {
+    const value = resolveData(data, getConditionScope(condition, path));
+    const context = {
+      data: value,
+      fullData: data,
+      path,
+      uischemaElement: uischema,
+    };
+    return condition.validate(context);
   } else {
     // unknown condition
     return true;
@@ -93,7 +110,7 @@ const isRuleFulfilled = (
   ajv: Ajv
 ): boolean => {
   const condition = uischema.rule.condition;
-  return evaluateCondition(data, condition, path, ajv);
+  return evaluateCondition(data, uischema, condition, path, ajv);
 };
 
 export const evalVisibility = (