@jsonforms/core 3.3.0 → 3.4.0-alpha.1

package/src/reducers/core.ts

@@ -27,11 +27,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';
-import isFunction from 'lodash/isFunction';
-import type Ajv from 'ajv';
-import type { ErrorObject, ValidateFunction } from 'ajv';
 import {
   CoreActions,
   INIT,
@@ -41,45 +37,17 @@ import {
   SET_SCHEMA,
   SET_UISCHEMA,
   SET_VALIDATION_MODE,
+  UPDATE_CORE,
   UPDATE_DATA,
   UPDATE_ERRORS,
-  UPDATE_CORE,
   UpdateCoreAction,
 } from '../actions';
-import { createAjv, decode, isOneOfEnumSchema, Reducer } from '../util';
-import type { JsonSchema, UISchemaElement } from '../models';
+import { JsonFormsCore, Reducer, ValidationMode } from '../store';
+import Ajv, { ErrorObject } from 'ajv';
+import { isFunction } from 'lodash';
+import { createAjv, validate } from '../util';
 
-export const validate = (
-  validator: ValidateFunction | undefined,
-  data: any
-): ErrorObject[] => {
-  if (validator === undefined) {
-    return [];
-  }
-  const valid = validator(data);
-  if (valid) {
-    return [];
-  }
-  return validator.errors;
-};
-
-export type ValidationMode =
-  | 'ValidateAndShow'
-  | 'ValidateAndHide'
-  | 'NoValidation';
-
-export interface JsonFormsCore {
-  data: any;
-  schema: JsonSchema;
-  uischema: UISchemaElement;
-  errors?: ErrorObject[];
-  additionalErrors?: ErrorObject[];
-  validator?: ValidateFunction;
-  ajv?: Ajv;
-  validationMode?: ValidationMode;
-}
-
-const initState: JsonFormsCore = {
+export const initState: JsonFormsCore = {
   data: {},
   schema: {},
   uischema: undefined,
@@ -90,32 +58,7 @@ const initState: JsonFormsCore = {
   additionalErrors: [],
 };
 
-const getOrCreateAjv = (
-  state: JsonFormsCore,
-  action?: InitAction | UpdateCoreAction
-): Ajv => {
-  if (action) {
-    if (hasAjvOption(action.options)) {
-      // options object with ajv
-      return action.options.ajv;
-    } else if (action.options !== undefined) {
-      // it is not an option object => should be ajv itself => check for compile function
-      if (isFunction(action.options.compile)) {
-        return action.options;
-      }
-    }
-  }
-  return state.ajv ? state.ajv : createAjv();
-};
-
-const hasAjvOption = (option: any): option is InitActionOptions => {
-  if (option) {
-    return option.ajv !== undefined;
-  }
-  return false;
-};
-
-const getValidationMode = (
+export const getValidationMode = (
   state: JsonFormsCore,
   action?: InitAction | UpdateCoreAction
 ): ValidationMode => {
@@ -141,7 +84,7 @@ const hasAdditionalErrorsOption = (
   return false;
 };
 
-const getAdditionalErrors = (
+export const getAdditionalErrors = (
   state: JsonFormsCore,
   action?: InitAction | UpdateCoreAction
 ): ErrorObject[] => {
@@ -151,6 +94,31 @@ const getAdditionalErrors = (
   return state.additionalErrors;
 };
 
+export const getOrCreateAjv = (
+  state: JsonFormsCore,
+  action?: InitAction | UpdateCoreAction
+): Ajv => {
+  if (action) {
+    if (hasAjvOption(action.options)) {
+      // options object with ajv
+      return action.options.ajv;
+    } else if (action.options !== undefined) {
+      // it is not an option object => should be ajv itself => check for compile function
+      if (isFunction(action.options.compile)) {
+        return action.options;
+      }
+    }
+  }
+  return state.ajv ? state.ajv : createAjv();
+};
+
+const hasAjvOption = (option: any): option is InitActionOptions => {
+  if (option) {
+    return option.ajv !== undefined;
+  }
+  return false;
+};
+
 export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
   state = initState,
   action
@@ -329,138 +297,3 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       return state;
   }
 };
-
-export const extractData = (state: JsonFormsCore) => get(state, 'data');
-export const extractSchema = (state: JsonFormsCore) => get(state, 'schema');
-export const extractUiSchema = (state: JsonFormsCore) => get(state, 'uischema');
-export const extractAjv = (state: JsonFormsCore) => get(state, 'ajv');
-
-const getInvalidProperty = (error: ErrorObject): string | undefined => {
-  switch (error.keyword) {
-    case 'required':
-    case 'dependencies':
-      return error.params.missingProperty;
-    case 'additionalProperties':
-      return error.params.additionalProperty;
-    default:
-      return undefined;
-  }
-};
-
-export const getControlPath = (error: ErrorObject) => {
-  // Up until AJV v7 the path property was called 'dataPath'
-  // With AJV v8 the property was renamed to 'instancePath'
-  let controlPath = (error as any).dataPath || error.instancePath || '';
-
-  // change '/' chars to '.'
-  controlPath = controlPath.replace(/\//g, '.');
-
-  const invalidProperty = getInvalidProperty(error);
-  if (invalidProperty !== undefined && !controlPath.endsWith(invalidProperty)) {
-    controlPath = `${controlPath}.${invalidProperty}`;
-  }
-
-  // remove '.' chars at the beginning of paths
-  controlPath = controlPath.replace(/^./, '');
-
-  // decode JSON Pointer escape sequences
-  controlPath = decode(controlPath);
-  return controlPath;
-};
-
-export const errorsAt =
-  (
-    instancePath: string,
-    schema: JsonSchema,
-    matchPath: (path: string) => boolean
-  ) =>
-  (errors: ErrorObject[]): ErrorObject[] => {
-    // Get data paths of oneOf and anyOf errors to later determine whether an error occurred inside a subschema of oneOf or anyOf.
-    const combinatorPaths = filter(
-      errors,
-      (error) => error.keyword === 'oneOf' || error.keyword === 'anyOf'
-    ).map((error) => getControlPath(error));
-
-    return filter(errors, (error) => {
-      // Filter errors that match any keyword that we don't want to show in the UI
-      // but keep the errors for oneOf enums
-      if (
-        filteredErrorKeywords.indexOf(error.keyword) !== -1 &&
-        !isOneOfEnumSchema(error.parentSchema)
-      ) {
-        return false;
-      }
-      const controlPath = getControlPath(error);
-      let result = matchPath(controlPath);
-      // In anyOf and oneOf blocks with "primitive" (i.e. string, number etc.) or array subschemas,
-      // we want to make sure that errors are only shown for the correct subschema.
-      // Therefore, we compare the error's parent schema with the property's schema.
-      // In the primitive case the error's data path is the same for all subschemas:
-      // It directly points to the property defining the anyOf/oneOf.
-      // The same holds true for errors on the array level (e.g. min item amount).
-      // In contrast, this comparison must not be done for errors whose parent schema defines an object or a oneOf enum,
-      // because the parent schema can never match the property schema (e.g. for 'required' checks).
-      const parentSchema: JsonSchema | undefined = error.parentSchema;
-      if (
-        result &&
-        !isObjectSchema(parentSchema) &&
-        !isOneOfEnumSchema(parentSchema) &&
-        combinatorPaths.findIndex((p) => instancePath.startsWith(p)) !== -1
-      ) {
-        result = result && isEqual(parentSchema, schema);
-      }
-      return result;
-    });
-  };
-
-/**
- * @returns true if the schema describes an object.
- */
-const isObjectSchema = (schema?: JsonSchema): boolean => {
-  return schema?.type === 'object' || !!schema?.properties;
-};
-
-/**
- * The error-type of an AJV error is defined by its `keyword` property.
- * Certain errors are filtered because they don't fit to any rendered control.
- * All of them have in common that we don't want to show them in the UI
- * because controls will show the actual reason why they don't match their correponding sub schema.
- * - additionalProperties: Indicates that a property is present that is not defined in the schema.
- *      Jsonforms only allows to edit defined properties. These errors occur if an oneOf doesn't match.
- * - allOf: Indicates that not all of the allOf definitions match as a whole.
- * - anyOf: Indicates that an anyOf definition itself is not valid because none of its subschemas matches.
- * - oneOf: Indicates that an oneOf definition itself is not valid because not exactly one of its subschemas matches.
- */
-const filteredErrorKeywords = [
-  'additionalProperties',
-  'allOf',
-  'anyOf',
-  'oneOf',
-];
-
-const getErrorsAt =
-  (
-    instancePath: string,
-    schema: JsonSchema,
-    matchPath: (path: string) => boolean
-  ) =>
-  (state: JsonFormsCore): ErrorObject[] => {
-    const errors = state.errors ?? [];
-    const additionalErrors = state.additionalErrors ?? [];
-    return errorsAt(
-      instancePath,
-      schema,
-      matchPath
-    )(
-      state.validationMode === 'ValidateAndHide'
-        ? additionalErrors
-        : [...errors, ...additionalErrors]
-    );
-  };
-
-export const errorAt = (instancePath: string, schema: JsonSchema) =>
-  getErrorsAt(instancePath, schema, (path) => path === instancePath);
-export const subErrorsAt = (instancePath: string, schema: JsonSchema) =>
-  getErrorsAt(instancePath, schema, (path) =>
-    path.startsWith(instancePath + '.')
-  );

package/src/reducers/default-data.ts

@@ -23,13 +23,15 @@
   THE SOFTWARE.
 */
 
+import get from 'lodash/get';
 import {
   ADD_DEFAULT_DATA,
-  RegisterDefaultDataAction,
   REMOVE_DEFAULT_DATA,
+  RegisterDefaultDataAction,
   UnregisterDefaultDataAction,
 } from '../actions';
-import type { Reducer } from '../util';
+import type { Reducer } from '../store/type';
+import { JsonFormsState } from '../store';
 
 export interface JsonFormsDefaultDataRegistryEntry {
   schemaPath: string;
@@ -56,6 +58,10 @@ export const defaultDataReducer: Reducer<
   }
 };
 
+export const getDefaultData = (
+  state: JsonFormsState
+): JsonFormsDefaultDataRegistryEntry[] =>
+  extractDefaultData(get(state, 'jsonforms.defaultData'));
 export const extractDefaultData = (
   state: JsonFormsDefaultDataRegistryEntry[]
 ): JsonFormsDefaultDataRegistryEntry[] => state;

package/src/reducers/i18n.ts

@@ -23,18 +23,15 @@
   THE SOFTWARE.
 */
 
-import {
-  defaultErrorTranslator,
-  defaultTranslator,
-  JsonFormsI18nState,
-} from '../i18n';
+import { defaultErrorTranslator, defaultTranslator } from '../i18n';
 import {
   I18nActions,
   SET_LOCALE,
   SET_TRANSLATOR,
   UPDATE_I18N,
 } from '../actions';
-import type { Reducer } from '../util';
+import { Reducer } from '../store/type';
+import { JsonFormsI18nState } from '../store';
 
 export const defaultJsonFormsI18nState: Required<JsonFormsI18nState> = {
   locale: 'en',
@@ -83,24 +80,3 @@ export const i18nReducer: Reducer<JsonFormsI18nState, I18nActions> = (
       return state;
   }
 };
-
-export const fetchLocale = (state?: JsonFormsI18nState) => {
-  if (state === undefined) {
-    return undefined;
-  }
-  return state.locale;
-};
-
-export const fetchTranslator = (state?: JsonFormsI18nState) => {
-  if (state === undefined) {
-    return defaultTranslator;
-  }
-  return state.translate;
-};
-
-export const fetchErrorTranslator = (state?: JsonFormsI18nState) => {
-  if (state === undefined) {
-    return defaultErrorTranslator;
-  }
-  return state.translateError;
-};

package/src/reducers/index.ts

@@ -30,6 +30,5 @@ export * from './default-data';
 export * from './i18n';
 export * from './reducers';
 export * from './renderers';
-export * from './selectors';
 export * from './uischemas';
 export * from './middleware';

package/src/reducers/middleware.ts

@@ -23,7 +23,7 @@
   THE SOFTWARE.
 */
 import { CoreActions } from '../actions';
-import { JsonFormsCore } from './core';
+import { JsonFormsCore } from '../store';
 
 export interface Middleware {
   (

package/src/reducers/reducers.ts

@@ -24,22 +24,18 @@
 */
 
 import type { ControlElement, UISchemaElement } from '../models';
-import { coreReducer, errorAt, subErrorsAt } from './core';
 import { defaultDataReducer } from './default-data';
 import { rendererReducer } from './renderers';
-import type { JsonFormsState } from '../store';
-import type { JsonFormsUISchemaRegistryEntry } from './uischemas';
 import { findMatchingUISchema, uischemaRegistryReducer } from './uischemas';
-import { fetchErrorTranslator, fetchLocale, i18nReducer } from './i18n';
+import { i18nReducer } from './i18n';
 
 import { Generate } from '../generators';
 import type { JsonSchema } from '../models/jsonSchema';
 
 import { cellReducer } from './cells';
 import { configReducer } from './config';
-import get from 'lodash/get';
-import { fetchTranslator } from '.';
-import type { ErrorTranslator, Translator } from '../i18n';
+import { coreReducer } from './core';
+import { JsonFormsUISchemaRegistryEntry } from '../store';
 
 export const jsonFormsReducerConfig = {
   core: coreReducer,
@@ -100,27 +96,3 @@ export const findUISchema = (
   }
   return uiSchema;
 };
-
-export const getErrorAt =
-  (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) => {
-    return errorAt(instancePath, schema)(state.jsonforms.core);
-  };
-
-export const getSubErrorsAt =
-  (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) =>
-    subErrorsAt(instancePath, schema)(state.jsonforms.core);
-
-export const getConfig = (state: JsonFormsState) => state.jsonforms.config;
-
-export const getLocale = (state: JsonFormsState) =>
-  fetchLocale(get(state, 'jsonforms.i18n'));
-
-export const getTranslator =
-  () =>
-  (state: JsonFormsState): Translator =>
-    fetchTranslator(get(state, 'jsonforms.i18n'));
-
-export const getErrorTranslator =
-  () =>
-  (state: JsonFormsState): ErrorTranslator =>
-    fetchErrorTranslator(get(state, 'jsonforms.i18n'));

package/src/reducers/renderers.ts

@@ -23,19 +23,14 @@
   THE SOFTWARE.
 */
 
-import type { RankedTester } from '../testers';
 import {
   ADD_RENDERER,
   AddRendererAction,
   REMOVE_RENDERER,
   RemoveRendererAction,
 } from '../actions';
-import type { Reducer } from '../util';
-
-export interface JsonFormsRendererRegistryEntry {
-  tester: RankedTester;
-  renderer: any;
-}
+import { Reducer } from '../store/type';
+import { JsonFormsRendererRegistryEntry } from '../store';
 
 type ValidRendererReducerActions = AddRendererAction | RemoveRendererAction;
 

package/src/reducers/uischemas.ts

@@ -28,18 +28,8 @@ import remove from 'lodash/remove';
 import { ADD_UI_SCHEMA, REMOVE_UI_SCHEMA, UISchemaActions } from '../actions';
 import { NOT_APPLICABLE } from '../testers';
 import type { JsonSchema, UISchemaElement } from '../models';
-import type { Reducer } from '../util';
-
-export type UISchemaTester = (
-  schema: JsonSchema,
-  schemaPath: string,
-  path: string
-) => number;
-
-export interface JsonFormsUISchemaRegistryEntry {
-  tester: UISchemaTester;
-  uischema: UISchemaElement;
-}
+import type { Reducer } from '../store/type';
+import { JsonFormsUISchemaRegistryEntry } from '../store';
 
 export const uischemaRegistryReducer: Reducer<
   JsonFormsUISchemaRegistryEntry[],

package/src/{util/array.ts → store/index.ts}

@@ -1,7 +1,7 @@
 /*
   The MIT License
 
-  Copyright (c) 2017-2019 EclipseSource Munich
+  Copyright (c) 2024-2024 EclipseSource Munich
   https://github.com/eclipsesource/jsonforms
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -23,21 +23,7 @@
   THE SOFTWARE.
 */
 
-const move = (array: any[], index: number, delta: number) => {
-  const newIndex: number = index + delta;
-  if (newIndex < 0 || newIndex >= array.length) {
-    return;
-  } // Already at the top or bottom.
-  const indexes: number[] = [index, newIndex].sort((a, b) => a - b); // Sort the indixes
-  array.splice(indexes[0], 2, array[indexes[1]], array[indexes[0]]);
-};
-
-const moveUp = (array: any[], toMove: number) => {
-  move(array, toMove, -1);
-};
-
-const moveDown = (array: any[], toMove: number) => {
-  move(array, toMove, 1);
-};
-
-export { moveUp, moveDown };
+export * from './store';
+export * from './type';
+export * from './i18nTypes';
+export * from './jsonFormsCore';

package/src/store/jsonFormsCore.ts

@@ -0,0 +1,72 @@
+import Ajv, { ErrorObject } from 'ajv';
+import { JsonSchema, UISchemaElement } from '../models';
+import get from 'lodash/get';
+import { errorsAt } from '../util';
+import {
+  JsonFormsCellRendererRegistryEntry,
+  JsonFormsCore,
+  JsonFormsRendererRegistryEntry,
+  JsonFormsState,
+  JsonFormsUISchemaRegistryEntry,
+} from './store';
+
+const getErrorsAt =
+  (
+    instancePath: string,
+    schema: JsonSchema,
+    matchPath: (path: string) => boolean
+  ) =>
+  (state: JsonFormsCore): ErrorObject[] => {
+    const errors = state.errors ?? [];
+    const additionalErrors = state.additionalErrors ?? [];
+    return errorsAt(
+      instancePath,
+      schema,
+      matchPath
+    )(
+      state.validationMode === 'ValidateAndHide'
+        ? additionalErrors
+        : [...errors, ...additionalErrors]
+    );
+  };
+
+export const errorAt = (instancePath: string, schema: JsonSchema) =>
+  getErrorsAt(instancePath, schema, (path) => path === instancePath);
+export const subErrorsAt = (instancePath: string, schema: JsonSchema) =>
+  getErrorsAt(instancePath, schema, (path) =>
+    path.startsWith(instancePath + '.')
+  );
+
+export const getErrorAt =
+  (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) => {
+    return errorAt(instancePath, schema)(state.jsonforms.core);
+  };
+
+export const getSubErrorsAt =
+  (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) =>
+    subErrorsAt(instancePath, schema)(state.jsonforms.core);
+
+export const getData = (state: JsonFormsState) =>
+  extractData(get(state, 'jsonforms.core'));
+export const getSchema = (state: JsonFormsState): JsonSchema =>
+  extractSchema(get(state, 'jsonforms.core'));
+export const getUiSchema = (state: JsonFormsState): UISchemaElement =>
+  extractUiSchema(get(state, 'jsonforms.core'));
+export const getAjv = (state: JsonFormsState): Ajv =>
+  extractAjv(get(state, 'jsonforms.core'));
+export const getRenderers = (
+  state: JsonFormsState
+): JsonFormsRendererRegistryEntry[] => get(state, 'jsonforms.renderers');
+export const getCells = (
+  state: JsonFormsState
+): JsonFormsCellRendererRegistryEntry[] => get(state, 'jsonforms.cells');
+export const getUISchemas = (
+  state: JsonFormsState
+): JsonFormsUISchemaRegistryEntry[] => get(state, 'jsonforms.uischemas');
+
+export const extractData = (state: JsonFormsCore) => get(state, 'data');
+export const extractSchema = (state: JsonFormsCore) => get(state, 'schema');
+export const extractUiSchema = (state: JsonFormsCore) => get(state, 'uischema');
+export const extractAjv = (state: JsonFormsCore) => get(state, 'ajv');
+
+export const getConfig = (state: JsonFormsState) => state.jsonforms.config;

package/src/{store.ts → store/store.ts}

@@ -23,14 +23,11 @@
   THE SOFTWARE.
 */
 
-import type { Store } from './util';
-import type {
-  JsonFormsCore,
-  JsonFormsCellRendererRegistryEntry,
-  JsonFormsRendererRegistryEntry,
-  JsonFormsUISchemaRegistryEntry,
-} from './reducers';
-import type { JsonFormsI18nState } from './i18n';
+import type { Store } from './type';
+import { RankedTester, UISchemaTester } from '../testers';
+import { JsonSchema, UISchemaElement } from '../models';
+import Ajv, { ErrorObject, ValidateFunction } from 'ajv';
+import { JsonFormsI18nState } from './i18nTypes';
 
 /**
  * JSONForms store.
@@ -80,6 +77,37 @@ export interface JsonFormsSubStates {
   [additionalState: string]: any;
 }
 
+export type ValidationMode =
+  | 'ValidateAndShow'
+  | 'ValidateAndHide'
+  | 'NoValidation';
+
+export interface JsonFormsCore {
+  data: any;
+  schema: JsonSchema;
+  uischema: UISchemaElement;
+  errors?: ErrorObject[];
+  additionalErrors?: ErrorObject[];
+  validator?: ValidateFunction;
+  ajv?: Ajv;
+  validationMode?: ValidationMode;
+}
+
+export interface JsonFormsRendererRegistryEntry {
+  tester: RankedTester;
+  renderer: any;
+}
+
+export interface JsonFormsUISchemaRegistryEntry {
+  tester: UISchemaTester;
+  uischema: UISchemaElement;
+}
+
+export interface JsonFormsCellRendererRegistryEntry {
+  tester: RankedTester;
+  cell: any;
+}
+
 export interface JsonFormsExtendedState<T> extends JsonFormsState {
   jsonforms: {
     [subState: string]: T;

package/src/testers/testers.ts

@@ -81,6 +81,12 @@ export interface TesterContext {
   config: any;
 }
 
+export type UISchemaTester = (
+  schema: JsonSchema,
+  schemaPath: string,
+  path: string
+) => number;
+
 export const isControl = (uischema: any): uischema is ControlElement =>
   !isEmpty(uischema) && uischema.scope !== undefined;