@jsonforms/core 3.2.1 → 3.3.0-alpha.1

package/lib/testers/testers.d.ts

@@ -71,6 +71,13 @@ export declare const uiTypeIs: (expected: string) => Tester;
  * @param {any} optionValue the expected value of the option
  */
 export declare const optionIs: (optionName: string, optionValue: any) => Tester;
+/**
+ * Checks whether the given UI schema has an option with the given
+ * name. If no options property is set, returns false.
+ *
+ * @param {string} optionName the name of the option to check
+ */
+export declare const hasOption: (optionName: string) => Tester;
 /**
  * Only applicable for Controls.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.2.1",
+  "version": "3.3.0-alpha.1",
   "description": "Core module of JSON Forms",
   "repository": "https://github.com/eclipsesource/jsonforms",
   "bugs": "https://github.com/eclipsesource/jsonforms/issues",
@@ -40,13 +40,12 @@
     "files": [
       "test/**/*"
     ],
-    "compileEnhancements": false,
     "extensions": [
       "ts"
     ],
     "require": [
       "./test-config/ts-node.config.js",
-      "source-map-support/register"
+      "source-map-support/register.js"
     ]
   },
   "nyc": {
@@ -66,9 +65,9 @@
     "@types/redux-mock-store": "^1.0.1",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
-    "ava": "~2.4.0",
+    "ava": "^6.1.2",
     "document-register-element": "^1.14.3",
-    "eslint": "^7.32.0",
+    "eslint": "^8.56.0",
     "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-prettier": "^4.2.1",
@@ -83,7 +82,7 @@
     "rollup-plugin-cleanup": "^3.2.1",
     "rollup-plugin-typescript2": "^0.34.1",
     "rollup-plugin-visualizer": "^5.4.1",
-    "source-map-support": "0.5.16",
+    "source-map-support": "^0.5.21",
     "ts-node": "^10.4.0",
     "tslib": "^2.5.0",
     "typedoc": "~0.25.3",

package/src/actions/actions.ts

@@ -56,6 +56,57 @@ export const UPDATE_I18N = 'jsonforms/UPDATE_I18N' as const;
 export const ADD_DEFAULT_DATA = 'jsonforms/ADD_DEFAULT_DATA' as const;
 export const REMOVE_DEFAULT_DATA = 'jsonforms/REMOVE_DEFAULT_DATA' as const;
 
+export type UpdateArrayContext =
+  | { type: 'ADD'; values: any[] }
+  | { type: 'REMOVE'; indices: number[] }
+  | { type: 'MOVE'; moves: { from: number; to: number }[] };
+
+export const isUpdateArrayContext = (
+  context: object
+): context is UpdateArrayContext => {
+  if (!('type' in context)) {
+    return false;
+  }
+  if (typeof context.type !== 'string') {
+    return false;
+  }
+  switch (context.type) {
+    case 'ADD': {
+      return (
+        'values' in context &&
+        Array.isArray(context.values) &&
+        context.values.length > 0
+      );
+    }
+    case 'REMOVE': {
+      return (
+        'indices' in context &&
+        Array.isArray(context.indices) &&
+        context.indices.length > 0 &&
+        context.indices.every((i) => typeof i === 'number')
+      );
+    }
+    case 'MOVE': {
+      return (
+        'moves' in context &&
+        Array.isArray(context.moves) &&
+        context.moves.length > 0 &&
+        context.moves.every(
+          (m) =>
+            typeof m === 'object' &&
+            m !== null &&
+            'from' in m &&
+            'to' in m &&
+            typeof m.from === 'number' &&
+            typeof m.to === 'number'
+        )
+      );
+    }
+    default:
+      return false;
+  }
+};
+
 export type CoreActions =
   | InitAction
   | UpdateCoreAction
@@ -70,6 +121,7 @@ export interface UpdateAction {
   type: 'jsonforms/UPDATE';
   path: string;
   updater(existingData?: any): any;
+  context?: object;
 }
 
 export interface UpdateErrorsAction {
@@ -165,11 +217,13 @@ export const setAjv = (ajv: AJV) => ({
 
 export const update = (
   path: string,
-  updater: (existingData: any) => any
+  updater: (existingData: any) => any,
+  context?: object
 ): UpdateAction => ({
   type: UPDATE_DATA,
   path,
   updater,
+  context,
 });
 
 export const updateErrors = (errors: ErrorObject[]): UpdateErrorsAction => ({

package/src/testers/testers.ts

@@ -31,6 +31,7 @@ import isArray from 'lodash/isArray';
 import reduce from 'lodash/reduce';
 import toPairs from 'lodash/toPairs';
 import includes from 'lodash/includes';
+import isUndefined from 'lodash/isUndefined';
 import type {
   Categorization,
   ControlElement,
@@ -215,6 +216,23 @@ export const optionIs =
     return !isEmpty(options) && options[optionName] === optionValue;
   };
 
+/**
+ * Checks whether the given UI schema has an option with the given
+ * name. If no options property is set, returns false.
+ *
+ * @param {string} optionName the name of the option to check
+ */
+export const hasOption =
+  (optionName: string): Tester =>
+  (uischema: UISchemaElement): boolean => {
+    if (isEmpty(uischema)) {
+      return false;
+    }
+
+    const options = uischema.options;
+    return !isEmpty(options) && !isUndefined(options[optionName]);
+  };
+
 /**
  * Only applicable for Controls.
  *

package/src/util/renderer.ts

@@ -59,7 +59,7 @@ import { moveDown, moveUp } from './array';
 import type { AnyAction, Dispatch } from './type';
 import { Resolve, convertDateToString, hasType } from './util';
 import { composePaths, composeWithUi } from './path';
-import { CoreActions, update } from '../actions';
+import { CoreActions, update, UpdateArrayContext } from '../actions';
 import type { ErrorObject } from 'ajv';
 import type { JsonFormsState } from '../store';
 import {
@@ -823,41 +823,63 @@ export const mapDispatchToArrayControlProps = (
 ): DispatchPropsOfArrayControl => ({
   addItem: (path: string, value: any) => () => {
     dispatch(
-      update(path, (array) => {
-        if (array === undefined || array === null) {
-          return [value];
-        }
-
-        array.push(value);
-        return array;
-      })
+      update(
+        path,
+        (array) => {
+          if (array === undefined || array === null) {
+            return [value];
+          }
+
+          array.push(value);
+          return array;
+        },
+        { type: 'ADD', values: [value] } as UpdateArrayContext
+      )
     );
   },
   removeItems: (path: string, toDelete: number[]) => () => {
     dispatch(
-      update(path, (array) => {
-        toDelete
-          .sort((a, b) => a - b)
-          .reverse()
-          .forEach((s) => array.splice(s, 1));
-        return array;
-      })
+      update(
+        path,
+        (array) => {
+          toDelete
+            .sort((a, b) => a - b)
+            .reverse()
+            .forEach((s) => array.splice(s, 1));
+          return array;
+        },
+        { type: 'REMOVE', indices: toDelete } as UpdateArrayContext
+      )
     );
   },
   moveUp: (path, toMove: number) => () => {
     dispatch(
-      update(path, (array) => {
-        moveUp(array, toMove);
-        return array;
-      })
+      update(
+        path,
+        (array) => {
+          moveUp(array, toMove);
+          return array;
+        },
+        {
+          type: 'MOVE',
+          moves: [{ from: toMove, to: toMove - 1 }],
+        } as UpdateArrayContext
+      )
     );
   },
   moveDown: (path, toMove: number) => () => {
     dispatch(
-      update(path, (array) => {
-        moveDown(array, toMove);
-        return array;
-      })
+      update(
+        path,
+        (array) => {
+          moveDown(array, toMove);
+          return array;
+        },
+        {
+          type: 'MOVE',
+          moves: [{ from: toMove, to: toMove + 1 }],
+        } as UpdateArrayContext
+      )
     );
   },
 });