@jsonforms/core 3.1.0 → 3.2.0-alpha.0

package/lib/models/uischema.d.ts

@@ -93,6 +93,18 @@ export interface LeafCondition extends Condition, Scoped {
 }
 export interface SchemaBasedCondition extends Condition, Scoped {
     schema: JsonSchema;
+    /**
+     * When the scope resolves to undefined and `failWhenUndefined` is set to `true`, the condition
+     * will fail. Therefore the reverse effect will be applied.
+     *
+     * Background:
+     * Most JSON Schemas will successfully validate against `undefined` data. Specifying that a
+     * condition shall fail when data is `undefined` requires to lift the scope to being able to use
+     * JSON Schema's `required`.
+     *
+     * Using `failWhenUndefined` allows to more conveniently express this condition.
+     */
+    failWhenUndefined?: boolean;
 }
 /**
  * A composable condition.

package/lib/util/renderer.d.ts

@@ -6,7 +6,7 @@ import type { AnyAction, Dispatch } from './type';
 import { CoreActions } from '../actions';
 import type { ErrorObject } from 'ajv';
 import type { JsonFormsState } from '../store';
-import { Translator } from '../i18n';
+import { Translator, CombinatorTranslations } from '../i18n';
 import { ArrayTranslations } from '../i18n/arrayTranslations';
 /**
  * Adds an asterisk to the given label string based
@@ -375,6 +375,7 @@ export interface StatePropsOfCombinator extends StatePropsOfControl {
     indexOfFittingSchema: number;
     uischemas: JsonFormsUISchemaRegistryEntry[];
     data: any;
+    translations: CombinatorTranslations;
 }
 export declare const mapStateToCombinatorRendererProps: (state: JsonFormsState, ownProps: OwnPropsOfControl, keyword: CombinatorKeyword) => StatePropsOfCombinator;
 export interface CombinatorRendererProps extends StatePropsOfCombinator, DispatchPropsOfControl {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.1.0",
+  "version": "3.2.0-alpha.0",
   "description": "Core module of JSON Forms",
   "repository": "https://github.com/eclipsesource/jsonforms",
   "bugs": "https://github.com/eclipsesource/jsonforms/issues",
@@ -42,9 +42,9 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "report": "nyc report --reporter=html",
-    "test": "cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\",\\\"target\\\":\\\"es5\\\"} ava",
-    "test-cov": "rimraf -rf .nyc_output && cross-env TS_NODE_COMPILER_OPTIONS={\\\"module\\\":\\\"commonjs\\\",\\\"target\\\":\\\"es5\\\"} nyc ava",
-    "doc": "typedoc --name 'JSON Forms Core' --mode file --excludeExternals --theme ../../typedoc-jsonforms --out docs src"
+    "test": "ava",
+    "test-cov": "rimraf -rf .nyc_output && nyc ava",
+    "doc": "typedoc --name 'JSON Forms Core' --excludeExternals --theme ../../typedoc-jsonforms --out docs src"
   },
   "ava": {
     "files": [
@@ -55,7 +55,7 @@
       "ts"
     ],
     "require": [
-      "ts-node/register",
+      "./test-config/ts-node.config.js",
       "source-map-support/register"
     ]
   },
@@ -69,7 +69,7 @@
     "@types/json-schema": "^7.0.3",
     "ajv": "^8.6.1",
     "ajv-formats": "^2.1.0",
-    "lodash": "^4.17.15"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
@@ -77,13 +77,12 @@
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
     "ava": "~2.4.0",
-    "cross-env": "^7.0.2",
     "document-register-element": "^1.14.3",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
-    "jsdom": "^15.2.1",
+    "jsdom": "^22.0.0",
     "jsdom-global": "^3.0.2",
     "nyc": "^15.1.0",
     "prettier": "^2.8.4",
@@ -92,12 +91,13 @@
     "rimraf": "^3.0.2",
     "rollup": "^2.78.0",
     "rollup-plugin-cleanup": "^3.2.1",
-    "rollup-plugin-typescript2": "^0.31.1",
+    "rollup-plugin-typescript2": "^0.34.1",
     "rollup-plugin-visualizer": "^5.4.1",
     "source-map-support": "0.5.16",
     "ts-node": "^10.4.0",
-    "typedoc": "^0.19.2",
+    "tslib": "^2.5.0",
+    "typedoc": "~0.21.9",
     "typescript": "4.2.3"
   },
-  "gitHead": "7e0115feeced7711b0768d325566aaa6b054c32b"
+  "gitHead": "9146b0fdf5913d2251fadd5435d2c7e813db6f71"
 }

package/src/i18n/combinatorTranslations.ts

@@ -0,0 +1,28 @@
+export interface CombinatorDefaultTranslation {
+  key: CombinatorTranslationEnum;
+  default: (variable?: string) => string;
+}
+
+export enum CombinatorTranslationEnum {
+  clearDialogTitle = 'clearDialogTitle',
+  clearDialogMessage = 'clearDialogMessage',
+  clearDialogAccept = 'clearDialogAccept',
+  clearDialogDecline = 'clearDialogDecline',
+}
+
+export type CombinatorTranslations = {
+  [key in CombinatorTranslationEnum]?: string;
+};
+
+export const combinatorDefaultTranslations: CombinatorDefaultTranslation[] = [
+  {
+    key: CombinatorTranslationEnum.clearDialogTitle,
+    default: () => 'Clear form?',
+  },
+  {
+    key: CombinatorTranslationEnum.clearDialogMessage,
+    default: () => 'Your data will be cleared. Do you want to proceed?',
+  },
+  { key: CombinatorTranslationEnum.clearDialogAccept, default: () => 'Yes' },
+  { key: CombinatorTranslationEnum.clearDialogDecline, default: () => 'No' },
+];

package/src/i18n/i18nUtil.ts

@@ -7,6 +7,10 @@ import {
   ArrayDefaultTranslation,
   ArrayTranslations,
 } from './arrayTranslations';
+import {
+  CombinatorDefaultTranslation,
+  CombinatorTranslations,
+} from './combinatorTranslations';
 
 export const getI18nKeyPrefixBySchema = (
   schema: i18nJsonSchema | undefined,
@@ -173,3 +177,17 @@ export const getArrayTranslations = (
   });
   return translations;
 };
+
+export const getCombinatorTranslations = (
+  t: Translator,
+  defaultTranslations: CombinatorDefaultTranslation[],
+  i18nKeyPrefix: string,
+  label: string
+): CombinatorTranslations => {
+  const translations: CombinatorTranslations = {};
+  defaultTranslations.forEach((controlElement) => {
+    const key = addI18nKeyToPrefix(i18nKeyPrefix, controlElement.key);
+    translations[controlElement.key] = t(key, controlElement.default(label));
+  });
+  return translations;
+};

package/src/i18n/index.ts

@@ -1,3 +1,4 @@
 export * from './i18nTypes';
 export * from './i18nUtil';
 export * from './arrayTranslations';
+export * from './combinatorTranslations';

package/src/models/uischema.ts

@@ -135,6 +135,19 @@ export interface LeafCondition extends Condition, Scoped {
 
 export interface SchemaBasedCondition extends Condition, Scoped {
   schema: JsonSchema;
+
+  /**
+   * When the scope resolves to undefined and `failWhenUndefined` is set to `true`, the condition
+   * will fail. Therefore the reverse effect will be applied.
+   *
+   * Background:
+   * Most JSON Schemas will successfully validate against `undefined` data. Specifying that a
+   * condition shall fail when data is `undefined` requires to lift the scope to being able to use
+   * JSON Schema's `required`.
+   *
+   * Using `failWhenUndefined` allows to more conveniently express this condition.
+   */
+  failWhenUndefined?: boolean;
 }
 
 /**

package/src/reducers/core.ts

@@ -25,6 +25,7 @@
 
 import cloneDeep from 'lodash/cloneDeep';
 import setFp from 'lodash/fp/set';
+import unsetFp from 'lodash/fp/unset';
 import get from 'lodash/get';
 import filter from 'lodash/filter';
 import isEqual from 'lodash/isEqual';
@@ -285,11 +286,19 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       } else {
         const oldData: any = get(state.data, action.path);
         const newData = action.updater(cloneDeep(oldData));
-        const newState: any = setFp(
-          action.path,
-          newData,
-          state.data === undefined ? {} : state.data
-        );
+        let newState: any;
+        if (newData !== undefined) {
+          newState = setFp(
+            action.path,
+            newData,
+            state.data === undefined ? {} : state.data
+          );
+        } else {
+          newState = unsetFp(
+            action.path,
+            state.data === undefined ? {} : state.data
+          );
+        }
         const errors = validate(state.validator, newState);
         return {
           ...state,

package/src/util/combinators.ts

@@ -35,18 +35,6 @@ export interface CombinatorSubSchemaRenderInfo {
 
 export type CombinatorKeyword = 'anyOf' | 'oneOf' | 'allOf';
 
-const createLabel = (
-  subSchema: JsonSchema,
-  subSchemaIndex: number,
-  keyword: CombinatorKeyword
-): string => {
-  if (subSchema.title) {
-    return subSchema.title;
-  } else {
-    return keyword + '-' + subSchemaIndex;
-  }
-};
-
 export const createCombinatorRenderInfos = (
   combinatorSubSchemas: JsonSchema[],
   rootSchema: JsonSchema,
@@ -56,9 +44,11 @@ export const createCombinatorRenderInfos = (
   uischemas: JsonFormsUISchemaRegistryEntry[]
 ): CombinatorSubSchemaRenderInfo[] =>
   combinatorSubSchemas.map((subSchema, subSchemaIndex) => {
-    const schema = subSchema.$ref
-      ? Resolve.schema(rootSchema, subSchema.$ref, rootSchema)
-      : subSchema;
+    const resolvedSubSchema =
+      subSchema.$ref && Resolve.schema(rootSchema, subSchema.$ref, rootSchema);
+
+    const schema = resolvedSubSchema ?? subSchema;
+
     return {
       schema,
       uischema: findUISchema(
@@ -70,6 +60,9 @@ export const createCombinatorRenderInfos = (
         control,
         rootSchema
       ),
-      label: createLabel(subSchema, subSchemaIndex, keyword),
+      label:
+        subSchema.title ??
+        resolvedSubSchema?.title ??
+        `${keyword}-${subSchemaIndex}`,
     };
   });

package/src/util/renderer.ts

@@ -70,6 +70,9 @@ import {
   getI18nKeyPrefixBySchema,
   getArrayTranslations,
   Translator,
+  CombinatorTranslations,
+  getCombinatorTranslations,
+  combinatorDefaultTranslations,
 } from '../i18n';
 import {
   arrayDefaultTranslations,
@@ -796,7 +799,7 @@ export const mapDispatchToArrayControlProps = (
     dispatch(
       update(path, (array) => {
         toDelete
-          .sort()
+          .sort((a, b) => a - b)
           .reverse()
           .forEach((s) => array.splice(s, 1));
         return array;
@@ -970,6 +973,7 @@ export interface StatePropsOfCombinator extends StatePropsOfControl {
   indexOfFittingSchema: number;
   uischemas: JsonFormsUISchemaRegistryEntry[];
   data: any;
+  translations: CombinatorTranslations;
 }
 
 export const mapStateToCombinatorRendererProps = (
@@ -977,12 +981,17 @@ export const mapStateToCombinatorRendererProps = (
   ownProps: OwnPropsOfControl,
   keyword: CombinatorKeyword
 ): StatePropsOfCombinator => {
-  const { data, schema, rootSchema, ...props } = mapStateToControlProps(
-    state,
-    ownProps
-  );
+  const { data, schema, rootSchema, i18nKeyPrefix, label, ...props } =
+    mapStateToControlProps(state, ownProps);
 
   const ajv = state.jsonforms.core.ajv;
+  const t = getTranslator()(state);
+  const translations = getCombinatorTranslations(
+    t,
+    combinatorDefaultTranslations,
+    i18nKeyPrefix,
+    label
+  );
   const structuralKeywords = [
     'required',
     'additionalProperties',
@@ -1025,8 +1034,11 @@ export const mapStateToCombinatorRendererProps = (
     schema,
     rootSchema,
     ...props,
+    i18nKeyPrefix,
+    label,
     indexOfFittingSchema,
     uischemas: getUISchemas(state),
+    translations,
   };
 };
 

package/src/util/runtime.ts

@@ -79,6 +79,9 @@ const evaluateCondition = (
     return value === condition.expectedValue;
   } else if (isSchemaCondition(condition)) {
     const value = resolveData(data, getConditionScope(condition, path));
+    if (condition.failWhenUndefined && value === undefined) {
+      return false;
+    }
     return ajv.validate(condition.schema, value) as boolean;
   } else {
     // unknown condition