@jsonforms/core 3.0.0-alpha.0 → 3.0.0-beta.0

package/src/generators/index.ts

@@ -22,25 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import { ControlElement, JsonSchema, UISchemaElement } from '../';
 
-import { generateJsonSchema } from './schema';
-import { createControlElement, generateDefaultUISchema } from './uischema';
-
-export const Generate: {
-  jsonSchema(instance: Object, options?: any): JsonSchema;
-  uiSchema(
-    jsonSchema: JsonSchema,
-    layoutType?: string,
-    prefix?: string,
-    rootSchema?: JsonSchema
-  ): UISchemaElement;
-  controlElement(ref: string): ControlElement;
-} = {
-  jsonSchema: generateJsonSchema,
-  uiSchema: generateDefaultUISchema,
-  controlElement: createControlElement
-};
-
-export { generateJsonSchema };
-export { generateDefaultUISchema };
+export * from './Generate';
+export * from './schema';
+export * from './uischema';

package/src/generators/schema.ts

@@ -23,7 +23,7 @@
   THE SOFTWARE.
 */
 
-import { JsonSchema4 } from '../models/jsonSchema4';
+import { JsonSchema4 } from '../models';
 
 const ADDITIONAL_PROPERTIES = 'additionalProperties';
 const REQUIRED_PROPERTIES = 'required';

package/src/generators/uischema.ts

@@ -22,20 +22,20 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
 import startCase from 'lodash/startCase';
 import keys from 'lodash/keys';
-import { JsonSchema } from '../models/jsonSchema';
 import {
   ControlElement,
   isGroup,
   isLayout,
+  JsonSchema,
   LabelElement,
   Layout,
   UISchemaElement
-} from '../models/uischema';
-import { resolveSchema } from '../util/resolvers';
-import { deriveTypes } from '../util';
+} from '../models';
+import { deriveTypes, resolveSchema } from '../util';
 
 /**
  * Creates a new ILayout.

package/src/i18n/i18nTypes.ts

@@ -0,0 +1,17 @@
+import { ErrorObject } from 'ajv';
+import { JsonSchema, UISchemaElement } from '../models';
+
+export type Translator = {
+    (id: string, defaultMessage: string, values?: any): string;
+    (id: string, defaultMessage: undefined, values?: any): string | undefined;
+}
+
+export type ErrorTranslator = (error: ErrorObject, translate: Translator, uischema?: UISchemaElement) => string;
+
+export interface JsonFormsI18nState {
+  locale?: string;
+  translate?: Translator;
+  translateError?: ErrorTranslator;
+}
+
+export type i18nJsonSchema = JsonSchema & {i18n?: string};

package/src/i18n/i18nUtil.ts

@@ -0,0 +1,105 @@
+import { ErrorObject } from 'ajv';
+import { UISchemaElement } from '../models';
+import { getControlPath } from '../reducers';
+import { formatErrorMessage } from '../util';
+import { i18nJsonSchema, ErrorTranslator, Translator } from './i18nTypes';
+
+export const getI18nKeyPrefixBySchema = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined
+): string | undefined => {
+  return uischema?.options?.i18n ?? schema?.i18n ?? undefined;
+};
+
+/**
+ * Transforms a given path to a prefix which can be used for i18n keys.
+ * Returns 'root' for empty paths and removes array indices
+ */
+export const transformPathToI18nPrefix = (path: string) => {
+  return (
+    path
+      ?.split('.')
+      .filter(segment => !/^\d+$/.test(segment))
+      .join('.') || 'root'
+  );
+};
+
+export const getI18nKeyPrefix = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined,
+  path: string | undefined
+): string | undefined => {
+  return (
+    getI18nKeyPrefixBySchema(schema, uischema) ??
+    transformPathToI18nPrefix(path)
+  );
+};
+
+export const getI18nKey = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined,
+  path: string | undefined,
+  key: string
+): string | undefined => {
+  return `${getI18nKeyPrefix(schema, uischema, path)}.${key}`;
+};
+
+export const defaultTranslator: Translator = (_id: string, defaultMessage: string | undefined) => defaultMessage;
+
+export const defaultErrorTranslator: ErrorTranslator = (error, t, uischema) => {
+  // check whether there is a special keyword message
+  const i18nKey = getI18nKey(
+    error.parentSchema,
+    uischema,
+    getControlPath(error),
+    `error.${error.keyword}`
+  );
+  const specializedKeywordMessage = t(i18nKey, undefined);
+  if (specializedKeywordMessage !== undefined) {
+    return specializedKeywordMessage;
+  }
+
+  // check whether there is a generic keyword message
+  const genericKeywordMessage = t(`error.${error.keyword}`, undefined);
+  if (genericKeywordMessage !== undefined) {
+    return genericKeywordMessage;
+  }
+
+  // check whether there is a customization for the default message
+  const messageCustomization = t(error.message, undefined);
+  if (messageCustomization !== undefined) {
+    return messageCustomization;
+  }
+
+  // rewrite required property messages (if they were not customized) as we place them next to the respective input
+  if (error.keyword === 'required' && error.message?.startsWith('must have required property')) {
+    return t('is a required property', 'is a required property');
+  }
+
+  return error.message;
+};
+
+/**
+ * Returns the determined error message for the given errors.
+ * All errors must correspond to the given schema, uischema or path.
+ */
+export const getCombinedErrorMessage = (
+  errors: ErrorObject[],
+  et: ErrorTranslator,
+  t: Translator,
+  schema?: i18nJsonSchema,
+  uischema?: UISchemaElement,
+  path?: string
+) => {
+  if (errors.length > 0 && t) {
+    // check whether there is a special message which overwrites all others
+    const customErrorKey = getI18nKey(schema, uischema, path, 'error.custom');
+    const specializedErrorMessage = t(customErrorKey, undefined);
+    if (specializedErrorMessage !== undefined) {
+      return specializedErrorMessage;
+    }
+  }
+  return formatErrorMessage(
+    errors.map(error => et(error, t, uischema))
+  );
+};

package/src/i18n/index.ts

@@ -0,0 +1,2 @@
+export * from './i18nTypes';
+export * from './i18nUtil';

package/src/index.ts

@@ -22,40 +22,16 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-export * from './util';
 
-export { JsonSchema } from './models/jsonSchema';
-export { JsonSchema4 } from './models/jsonSchema4';
-export { JsonSchema7 } from './models/jsonSchema7';
-export * from './store';
 export * from './actions';
-import * as Actions from './actions';
-export { Actions };
-export * from './reducers';
+export * as Actions from './actions';
 export * from './generators';
-
-export * from './models/uischema';
-
-import * as Test from './testers';
+export * from './models';
+export * from './reducers';
 export * from './testers';
-export { Test };
-
-import { convertToValidClassName, createLabelDescriptionFrom } from './util';
-import { ControlElement, LabelDescription } from './models/uischema';
-import { JsonSchema } from './models/jsonSchema';
-
-const Helpers: {
-  createLabelDescriptionFrom(
-    withLabel: ControlElement,
-    schema: JsonSchema
-  ): LabelDescription;
-  convertToValidClassName(s: string): string;
-} = {
-  createLabelDescriptionFrom,
-  convertToValidClassName
-};
-
-export { Helpers };
-
+export * as Test from './testers';
 export * from './util';
+
+export * from './Helpers';
 export * from './store';
+export * from './i18n';

package/src/models/draft4.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 export const Draft4 = {
   id: 'http://json-schema.org/draft-04/schema#',
   $schema: 'http://json-schema.org/draft-04/schema#',

package/{lib/util/type.js → src/models/index.ts}

@@ -1,20 +1,19 @@
-"use strict";
 /*
   The MIT License
-
+  
   Copyright (c) 2017-2019 EclipseSource Munich
   https://github.com/eclipsesource/jsonforms
-
+  
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software and associated documentation files (the "Software"), to deal
   in the Software without restriction, including without limitation the rights
   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   copies of the Software, and to permit persons to whom the Software is
   furnished to do so, subject to the following conditions:
-
+  
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
-
+  
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -23,5 +22,9 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=type.js.map
+
+export * from './draft4';
+export * from './jsonSchema';
+export * from './jsonSchema4';
+export * from './jsonSchema7';
+export * from './uischema';

package/src/models/jsonSchema.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { JsonSchema4 } from './jsonSchema4';
 import { JsonSchema7 } from './jsonSchema7';
 

package/src/models/uischema.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { JsonSchema } from './jsonSchema';
 
 /**

package/src/reducers/cells.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { RankedTester } from '../testers';
 import {
   ADD_CELL,
@@ -29,7 +30,7 @@ import {
   REMOVE_CELL,
   RemoveCellRendererAction
 } from '../actions';
-import { Reducer } from '../util/type';
+import { Reducer } from '../util';
 
 type ValidCellReducerActions = AddCellRendererAction | RemoveCellRendererAction;
 

package/src/reducers/config.ts

@@ -22,10 +22,11 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import merge from 'lodash/merge';
 import { SET_CONFIG, SetConfigAction } from '../actions';
 import { configDefault } from '../configDefault';
-import { Reducer } from '../util/type';
+import { Reducer } from '../util';
 
 const applyDefaultConfiguration = (config: any = {}) =>
   merge({}, configDefault, config);

package/src/reducers/core.ts

@@ -22,13 +22,14 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import cloneDeep from 'lodash/cloneDeep';
 import setFp from 'lodash/fp/set';
 import get from 'lodash/get';
 import filter from 'lodash/filter';
 import isEqual from 'lodash/isEqual';
 import isFunction from 'lodash/isFunction';
-import { Ajv, ErrorObject, ValidateFunction } from 'ajv';
+import Ajv, { ErrorObject, ValidateFunction } from 'ajv';
 import {
   CoreActions,
   INIT,
@@ -43,32 +44,20 @@ import {
   UPDATE_CORE,
   UpdateCoreAction
 } from '../actions';
-import { createAjv } from '../util/validator';
-import { Reducer } from '../util/type';
-import { JsonSchema, UISchemaElement } from '..';
+import { createAjv, Reducer } from '../util';
+import { JsonSchema, UISchemaElement } from '../models';
 
-const validate = (validator: ValidateFunction, data: any): ErrorObject[] => {
+export const validate = (validator: ValidateFunction | undefined, data: any): ErrorObject[] => {
+  if (validator === undefined) {
+    return [];
+  }
   const valid = validator(data);
   if (valid) {
     return [];
   }
-
   return validator.errors;
 };
 
-export const sanitizeErrors = (validator: ValidateFunction, data: any) => {
-  if (validator === alwaysValid) {
-    return [];
-  }
-  return validate(validator, data).map(error => {
-    error.dataPath = error.dataPath.replace(/\//g, '.').substr(1);
-
-    return error;
-  });
-};
-
-const alwaysValid: ValidateFunction = () => true;
-
 export type ValidationMode = 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation';
 
 export interface JsonFormsCore {
@@ -86,9 +75,9 @@ const initState: JsonFormsCore = {
   schema: {},
   uischema: undefined,
   errors: [],
-  validator: alwaysValid,
+  validator: undefined,
   ajv: undefined,
-  validationMode: 'ValidateAndShow'
+  validationMode: 'ValidateAndShow',
 };
 
 const reuseAjvForSchema = (ajv: Ajv, schema: JsonSchema): Ajv => {
@@ -104,7 +93,7 @@ const getOrCreateAjv = (state: JsonFormsCore, action?: InitAction | UpdateCoreAc
       // options object with ajv
       return action.options.ajv;
     } else if (
-      action.options !== undefined 
+      action.options !== undefined
     ) {
       // it is not an option object => should be ajv itself => check for compile function
       if (isFunction(action.options.compile)) {
@@ -154,8 +143,8 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       const thisAjv = getOrCreateAjv(state, action);
 
       const validationMode = getValidationMode(state, action);
-      const v = validationMode === 'NoValidation' ? alwaysValid : thisAjv.compile(action.schema);
-      const e = sanitizeErrors(v, action.data);
+      const v = validationMode === 'NoValidation' ? undefined : thisAjv.compile(action.schema);
+      const e = validate(v, action.data);
 
       return {
         ...state,
@@ -165,7 +154,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         errors: e,
         validator: v,
         ajv: thisAjv,
-        validationMode
+        validationMode,
       };
     }
     case UPDATE_CORE: {
@@ -181,11 +170,11 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         // revalidate only if necessary
         validator =
           validationMode === 'NoValidation'
-            ? alwaysValid
+            ? undefined
             : thisAjv.compile(action.schema);
-        errors = sanitizeErrors(validator, action.data);
+        errors = validate(validator, action.data);
       } else if (state.data !== action.data) {
-        errors = sanitizeErrors(validator, action.data);
+        errors = validate(validator, action.data);
       }
 
       const stateChanged =
@@ -195,24 +184,24 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         state.ajv !== thisAjv ||
         state.errors !== errors ||
         state.validator !== validator ||
-        state.validationMode !== validationMode;
+        state.validationMode !== validationMode
       return stateChanged
         ? {
             ...state,
-            data: state.data === action.data ? state.data : action.data,
-            schema: state.schema === action.schema ? state.schema : action.schema,
-            uischema: state.uischema === action.uischema ? state.uischema : action.uischema,
-            ajv: thisAjv === state.ajv ? state.ajv : thisAjv,
+            data: action.data,
+            schema: action.schema,
+            uischema: action.uischema,
+            ajv: thisAjv,
             errors: isEqual(errors, state.errors) ? state.errors : errors,
-            validator: validator === state.validator ? state.validator : validator,
-            validationMode: validationMode === state.validationMode ? state.validationMode : validationMode
+            validator: validator,
+            validationMode: validationMode,
           }
         : state;
     }
     case SET_AJV: {
       const currentAjv = action.ajv;
-      const validator = state.validationMode === 'NoValidation' ? alwaysValid : currentAjv.compile(state.schema);
-      const errors = sanitizeErrors(validator, state.data);
+      const validator = state.validationMode === 'NoValidation' ? undefined : currentAjv.compile(state.schema);
+      const errors = validate(validator, state.data);
       return {
         ...state,
         validator,
@@ -224,7 +213,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       const v = needsNewValidator
         ? reuseAjvForSchema(state.ajv, action.schema).compile(action.schema)
         : state.validator;
-      const errors = sanitizeErrors(v, state.data);
+      const errors = validate(v, state.data);
       return {
         ...state,
         validator: v,
@@ -244,7 +233,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       } else if (action.path === '') {
         // empty path is ok
         const result = action.updater(cloneDeep(state.data));
-        const errors = sanitizeErrors(state.validator, result);
+        const errors = validate(state.validator, result);
         return {
           ...state,
           data: result,
@@ -258,7 +247,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
           newData,
           state.data === undefined ? {} : state.data
         );
-        const errors = sanitizeErrors(state.validator, newState);
+        const errors = validate(state.validator, newState);
         return {
           ...state,
           data: newState,
@@ -277,17 +266,16 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         return state;
       }
       if (action.validationMode === 'NoValidation') {
-        const errors = sanitizeErrors(alwaysValid, state.data);
+        const errors = validate(undefined, state.data);
         return {
           ...state,
-          validator: alwaysValid,
           errors,
           validationMode: action.validationMode
         };
       }
       if (state.validationMode === 'NoValidation') {
         const validator = reuseAjvForSchema(state.ajv, state.schema).compile(state.schema);
-        const errors = sanitizeErrors(validator, state.data);
+        const errors = validate(validator, state.data);
         return {
           ...state,
           validator,
@@ -310,6 +298,40 @@ 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) => {
+  const dataPath = (error as any).dataPath;
+  // older AJV version
+  if (dataPath) {
+    return dataPath.replace(/\//g, '.').substr(1);
+  }
+  // dataPath was renamed to instancePath in AJV v8
+  var controlPath: string = 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(/^./, '');
+  return controlPath;
+}
+
 export const errorsAt = (
   instancePath: string,
   schema: JsonSchema,
@@ -319,15 +341,15 @@ export const errorsAt = (
   const combinatorPaths = filter(
     errors,
     error => error.keyword === 'oneOf' || error.keyword === 'anyOf'
-  ).map(error => error.dataPath);
-
-  return filter(errors, error => {
-    // Filter errors that match any keyword that we don't want to show in the UI
-    if (filteredErrorKeywords.indexOf(error.keyword) !== -1) {
-      return false;
-    }
-
-    let result = matchPath(error.dataPath);
+    ).map(error => getControlPath(error));
+    
+    return filter(errors, error => {
+      // Filter errors that match any keyword that we don't want to show in the UI
+      if (filteredErrorKeywords.indexOf(error.keyword) !== -1) {
+        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.

package/src/reducers/default-data.ts

@@ -22,13 +22,14 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import {
   ADD_DEFAULT_DATA,
   RegisterDefaultDataAction,
   REMOVE_DEFAULT_DATA,
   UnregisterDefaultDataAction
 } from '../actions';
-import { Reducer } from '../util/type';
+import { Reducer } from '../util';
 
 export interface JsonFormsDefaultDataRegistryEntry {
   schemaPath: string;