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

package/src/util/index.ts

@@ -22,131 +22,19 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import isEmpty from 'lodash/isEmpty';
-import isArray from 'lodash/isArray';
-import includes from 'lodash/includes';
-import find from 'lodash/find';
-import { JsonSchema, Scopable, UISchemaElement } from '../';
-import { resolveData, resolveSchema } from './resolvers';
-import {
-  compose as composePaths,
-  composeWithUi,
-  toDataPath,
-  toDataPathSegments
-} from './path';
-import { isEnabled, isVisible } from './runtime';
-import { Ajv } from 'ajv';
 
-export { createCleanLabel, createLabelDescriptionFrom } from './label';
-
-/**
- * Escape the given string such that it can be used as a class name,
- * i.e. hashes and slashes will be replaced.
- *
- * @param {string} s the string that should be converted to a valid class name
- * @returns {string} the escaped string
- */
-export const convertToValidClassName = (s: string): string =>
-  s.replace('#', 'root').replace(new RegExp('/', 'g'), '_');
-
-export const formatErrorMessage = (errors: string[]) => {
-  if (errors === undefined || errors === null) {
-    return '';
-  }
-
-  return errors.join('\n');
-};
-
-const hasType = (jsonSchema: JsonSchema, expected: string): boolean => {
-  return includes(deriveTypes(jsonSchema), expected);
-};
-
-/**
- * Derives the type of the jsonSchema element
- */
-const deriveTypes = (jsonSchema: JsonSchema): string[] => {
-  if (isEmpty(jsonSchema)) {
-    return [];
-  }
-  if (!isEmpty(jsonSchema.type) && typeof jsonSchema.type === 'string') {
-    return [jsonSchema.type];
-  }
-  if (isArray(jsonSchema.type)) {
-    return jsonSchema.type;
-  }
-  if (
-    !isEmpty(jsonSchema.properties) ||
-    !isEmpty(jsonSchema.additionalProperties)
-  ) {
-    return ['object'];
-  }
-  if (!isEmpty(jsonSchema.items)) {
-    return ['array'];
-  }
-
-  if (!isEmpty(jsonSchema.allOf)) {
-    const allOfType = find(
-      jsonSchema.allOf,
-      (schema: JsonSchema) => deriveTypes(schema).length !== 0
-    );
-
-    if (allOfType) {
-      return deriveTypes(allOfType);
-    }
-  }
-  // ignore all remaining cases
-  return [];
-};
-
-/**
- * Convenience wrapper around resolveData and resolveSchema.
- */
-const Resolve: {
-  schema(
-    schema: JsonSchema,
-    schemaPath: string,
-    rootSchema?: JsonSchema
-  ): JsonSchema;
-  data(data: any, path: string): any;
-} = {
-  schema: resolveSchema,
-  data: resolveData
-};
-export {
-  resolveData,
-  resolveSchema,
-} from './resolvers';
-export { Resolve };
-
-// Paths --
-const fromScopable = (scopable: Scopable) =>
-  toDataPathSegments(scopable.scope).join('.');
-
-const Paths = {
-  compose: composePaths,
-  fromScopable
-};
-export { composePaths, composeWithUi, Paths, toDataPath };
-
-// Runtime --
-const Runtime = {
-  isEnabled(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
-    return isEnabled(uischema, data,undefined, ajv);
-  },
-  isVisible(uischema: UISchemaElement, data: any, ajv: Ajv): boolean {
-    return isVisible(uischema, data, undefined, ajv);
-  }
-};
-export { isEnabled, isVisible, Runtime, deriveTypes, hasType };
-
-export * from './renderer';
+export * from './array';
 export * from './cell';
-export * from './runtime';
+export * from './combinators';
 export * from './Formatted';
 export * from './ids';
-export * from './validator';
-export * from './combinators';
-export * from './uischema';
-export * from './array';
-export * from './type';
+export * from './label';
+export * from './path';
+export * from './renderer';
+export * from './resolvers';
+export * from './runtime';
 export * from './schema';
+export * from './type';
+export * from './uischema';
+export * from './util';
+export * from './validator';

package/src/util/label.ts

@@ -22,10 +22,10 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import startCase from 'lodash/startCase';
 
-import { ControlElement, LabelDescription } from '../models/uischema';
-import { JsonSchema } from '../models/jsonSchema';
+import { ControlElement, JsonSchema, LabelDescription } from '../models';
 
 const deriveLabel = (
   controlElement: ControlElement,

package/src/util/path.ts

@@ -22,9 +22,10 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
 import range from 'lodash/range';
-import { Scopable } from '../';
+import { Scopable } from '../models';
 
 export const compose = (path1: string, path2: string) => {
   let p1 = path1;
@@ -41,6 +42,8 @@ export const compose = (path1: string, path2: string) => {
   }
 };
 
+export { compose as composePaths };
+
 /**
  * Convert a schema path (i.e. JSON pointer) to an array by splitting
  * at the '/' character and removing all schema-specific keywords.

package/src/util/renderer.ts

@@ -22,10 +22,14 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import get from 'lodash/get';
-import { ControlElement, UISchemaElement } from '../models/uischema';
-import union from 'lodash/union';
+import { ControlElement, JsonSchema, UISchemaElement } from '../models';
 import find from 'lodash/find';
+import type {
+  JsonFormsCellRendererRegistryEntry,
+  JsonFormsRendererRegistryEntry,
+} from '../reducers';
 import {
   findUISchema,
   getAjv,
@@ -33,46 +37,26 @@ import {
   getConfig,
   getData,
   getErrorAt,
+  getErrorTranslator,
   getRenderers,
   getSchema,
   getSubErrorsAt,
-  getUiSchema
+  getTranslator,
+  getUiSchema,
+  JsonFormsUISchemaRegistryEntry,
 } from '../reducers';
 import { RankedTester } from '../testers';
-import { JsonSchema } from '../models/jsonSchema';
-import {
-  AnyAction,
-  CombinatorKeyword,
-  composePaths,
-  composeWithUi,
-  createLabelDescriptionFrom,
-  Dispatch,
-  formatErrorMessage,
-  hasShowRule,
-  isInherentlyEnabled,
-  isVisible,
-  moveDown,
-  moveUp,
-  Resolve,
-  resolveSubSchemas
-} from '../util';
+import { hasShowRule, isInherentlyEnabled, isVisible } from './runtime';
+import { createLabelDescriptionFrom } from './label';
+import { CombinatorKeyword, resolveSubSchemas } from './combinators';
+import { moveDown, moveUp } from './array';
+import { AnyAction, Dispatch } from './type';
+import { Resolve } from './util';
+import { composePaths, composeWithUi } from './path';
 import { CoreActions, update } from '../actions';
 import { ErrorObject } from 'ajv';
 import { JsonFormsState } from '../store';
-import { JsonFormsRendererRegistryEntry } from '../reducers/renderers';
-import { JsonFormsCellRendererRegistryEntry } from '../reducers/cells';
-import { JsonFormsUISchemaRegistryEntry } from '../reducers/uischemas';
-
-export { JsonFormsRendererRegistryEntry, JsonFormsCellRendererRegistryEntry };
-
-export interface Labels {
-  default: string;
-  [additionalLabels: string]: string;
-}
-
-export const isPlainLabel = (label: string | Labels): label is string => {
-  return typeof label === 'string';
-};
+import { getCombinedErrorMessage, getI18nKey, getI18nKeyPrefix, Translator } from '../i18n';
 
 const isRequired = (
   schema: JsonSchema,
@@ -103,16 +87,31 @@ const isRequired = (
  * Adds an asterisk to the given label string based
  * on the required parameter.
  *
- * @param {string} label the label string
+ * @param {string | undefined} label the label string
  * @param {boolean} required whether the label belongs to a control which is required
+ * @param {boolean} hideRequiredAsterisk applied UI Schema option
  * @returns {string} the label string
  */
 export const computeLabel = (
-  label: string,
+  label: string | undefined,
   required: boolean,
   hideRequiredAsterisk: boolean
 ): string => {
-  return required && !hideRequiredAsterisk ? label + '*' : label;
+  return `${label ?? ''}${ required && !hideRequiredAsterisk ? '*' : ''}`;
+};
+
+/**
+ * Indicates whether to mark a field as required.
+ *
+ * @param {boolean} required whether the label belongs to a control which is required
+ * @param {boolean} hideRequiredAsterisk applied UI Schema option
+ * @returns {boolean} should the field be marked as required
+ */
+ export const showAsRequired = (
+  required: boolean,
+  hideRequiredAsterisk: boolean
+): boolean => {
+  return required && !hideRequiredAsterisk;
 };
 
 /**
@@ -156,7 +155,7 @@ export const createDefaultValue = (schema: JsonSchema) => {
  */
 export const isDescriptionHidden = (
   visible: boolean,
-  description: string,
+  description: string | undefined,
   isFocused: boolean,
   showUnfocusedDescription: boolean
 ): boolean => {
@@ -176,16 +175,45 @@ export interface EnumOption {
   value: any;
 }
 
-export const enumToEnumOptionMapper = (e: any): EnumOption => {
-  const stringifiedEnum = typeof e === 'string' ? e : JSON.stringify(e);
-  return { label: stringifiedEnum, value: e };
+export const enumToEnumOptionMapper = (
+  e: any,
+  t?: Translator,
+  i18nKey?: string
+): EnumOption => {
+  let label = typeof e === 'string' ? e : JSON.stringify(e);
+  if (t) {
+    if (i18nKey) {
+      label = t(`${i18nKey}.${label}`, label);
+    } else {
+      label = t(label, label);
+    }
+  }
+  return { label, value: e };
 };
 
-export const oneOfToEnumOptionMapper = (e: any): EnumOption => ({
-  value: e.const,
-  label:
-    e.title ?? (typeof e.const === 'string' ? e.const : JSON.stringify(e.const))
-});
+export const oneOfToEnumOptionMapper = (
+  e: any,
+  t?: Translator,
+  fallbackI18nKey?: string
+): EnumOption => {
+  let label =
+    e.title ??
+    (typeof e.const === 'string' ? e.const : JSON.stringify(e.const));
+  if (t) {
+    // prefer schema keys as they can be more specialized
+    if (e.i18n) {
+      label = t(e.i18n, label);
+    } else if (fallbackI18nKey) {
+      label = t(`${fallbackI18nKey}.${label}`, label);
+    } else {
+      label = t(label, label);
+    }
+  }
+  return {
+    label,
+    value: e.const,
+  };
+};
 
 export interface OwnPropsOfRenderer {
   /**
@@ -325,7 +353,7 @@ export interface StatePropsOfControl extends StatePropsOfScopedRenderer {
   /**
    * The label for the rendered element.
    */
-  label: string | Labels;
+  label: string;
 
   /**
    * Description of input cell
@@ -415,9 +443,8 @@ export const mapStateToControlProps = (
     controlElement.scope,
     rootSchema
   );
-  const errors = formatErrorMessage(
-    union(getErrorAt(path, resolvedSchema)(state).map(error => error.message))
-  );
+  const errors = getErrorAt(path, resolvedSchema)(state);
+  
   const description =
     resolvedSchema !== undefined ? resolvedSchema.description : '';
   const data = Resolve.data(rootData, path);
@@ -432,18 +459,26 @@ export const mapStateToControlProps = (
     rootData,
     config
   );
+
+  const schema = resolvedSchema ?? rootSchema;
+  const t = getTranslator()(state);
+  const te = getErrorTranslator()(state);
+  const i18nLabel = t(getI18nKey(schema, uischema, path, 'label'), label);
+  const i18nDescription = t(getI18nKey(schema, uischema, path, 'description'), description);
+  const i18nErrorMessage = getCombinedErrorMessage(errors, te, t, schema, uischema, path);
+
   return {
     data,
-    description,
-    errors,
-    label,
+    description: i18nDescription,
+    errors: i18nErrorMessage,
+    label: i18nLabel,
     visible,
     enabled,
     id,
     path,
     required,
-    uischema: ownProps.uischema,
-    schema: resolvedSchema || rootSchema,
+    uischema,
+    schema,
     config: getConfig(state),
     cells: ownProps.cells || state.jsonforms.cells,
     rootSchema
@@ -478,8 +513,20 @@ export const mapStateToEnumControlProps = (
   const props: StatePropsOfControl = mapStateToControlProps(state, ownProps);
   const options: EnumOption[] =
     ownProps.options ||
-    props.schema.enum?.map(enumToEnumOptionMapper) ||
-    (props.schema.const && [enumToEnumOptionMapper(props.schema.const)]);
+    props.schema.enum?.map(e =>
+      enumToEnumOptionMapper(
+        e,
+        getTranslator()(state),
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
+      )
+    ) ||
+    (props.schema.const && [
+      enumToEnumOptionMapper(
+        props.schema.const,
+        getTranslator()(state),
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
+      )
+    ]);
   return {
     ...props,
     options
@@ -499,7 +546,13 @@ export const mapStateToOneOfEnumControlProps = (
   const props: StatePropsOfControl = mapStateToControlProps(state, ownProps);
   const options: EnumOption[] =
     ownProps.options ||
-    (props.schema.oneOf as JsonSchema[])?.map(oneOfToEnumOptionMapper);
+    (props.schema.oneOf as JsonSchema[])?.map(oneOfSubSchema =>
+      oneOfToEnumOptionMapper(
+        oneOfSubSchema,
+        getTranslator()(state),
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
+      )
+    );
   return {
     ...props,
     options
@@ -521,8 +574,20 @@ export const mapStateToMultiEnumControlProps = (
   const options: EnumOption[] =
     ownProps.options ||
     (items?.oneOf &&
-      (items.oneOf as JsonSchema[]).map(oneOfToEnumOptionMapper)) ||
-    items?.enum?.map(enumToEnumOptionMapper);
+      (items.oneOf as JsonSchema[]).map(oneOfSubSchema =>
+        oneOfToEnumOptionMapper(
+          oneOfSubSchema,
+          state.jsonforms.i18n?.translate,
+          getI18nKeyPrefix(props.schema, props.uischema, props.path)
+        )
+      )) ||
+    items?.enum?.map(e =>
+      enumToEnumOptionMapper(
+        e,
+        state.jsonforms.i18n?.translate,
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
+      )
+    );
   return {
     ...props,
     options
@@ -857,7 +922,7 @@ export interface StatePropsOfCombinator extends OwnPropsOfControl {
   data: any;
 }
 
-const mapStateToCombinatorRendererProps = (
+export const mapStateToCombinatorRendererProps = (
   state: JsonFormsState,
   ownProps: OwnPropsOfControl,
   keyword: CombinatorKeyword
@@ -885,7 +950,8 @@ const mapStateToCombinatorRendererProps = (
     'required',
     'additionalProperties',
     'type',
-    'enum'
+    'enum',
+    'const'
   ];
   const dataIsValid = (errors: ErrorObject[]): boolean => {
     return (
@@ -977,9 +1043,18 @@ export const mapStateToArrayLayoutProps = (
   } = mapStateToControlWithDetailProps(state, ownProps);
 
   const resolvedSchema = Resolve.schema(schema, 'items', props.rootSchema);
-  const childErrors = formatErrorMessage(
-    getSubErrorsAt(path, resolvedSchema)(state).map(error => error.message)
+
+  // TODO Does not consider a specialized '.custom' error message overriding all other error messages
+  // TODO Does not consider 'i18n' keys which are specified in the ui schemas of the sub errors
+  const childErrors = getCombinedErrorMessage(
+    getSubErrorsAt(path, resolvedSchema)(state),
+    getErrorTranslator()(state),
+    getTranslator()(state),
+    undefined,
+    undefined,
+    undefined
   );
+
   const allErrors =
     errors +
     (errors.length > 0 && childErrors.length > 0 ? '\n' : '') +
@@ -995,8 +1070,6 @@ export const mapStateToArrayLayoutProps = (
   };
 };
 
-export type CombinatorProps = StatePropsOfCombinator & DispatchPropsOfControl;
-
 /**
  * Props of an array control.
  */

package/src/util/resolvers.ts

@@ -22,9 +22,10 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
 import get from 'lodash/get';
-import { JsonSchema } from '../models/jsonSchema';
+import { JsonSchema } from '../models';
 
 /**
  * Map for storing refs and the respective schemas they are pointing to.

package/src/util/runtime.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import has from 'lodash/has';
 import {
   AndCondition,
@@ -32,10 +33,10 @@ import {
   SchemaBasedCondition,
   Scopable,
   UISchemaElement
-} from '../models/uischema';
+} from '../models';
 import { resolveData } from './resolvers';
 import { composeWithUi } from './path';
-import { Ajv } from 'ajv';
+import Ajv from 'ajv';
 import { getAjv } from '../reducers';
 import { JsonFormsState } from '../store';
 import { JsonSchema } from '../models/jsonSchema';

package/src/util/schema.ts

@@ -1,4 +1,29 @@
-import find from "lodash/find";
+/*
+  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
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+*/
+
+import find from 'lodash/find';
 
 export const getFirstPrimitiveProp = (schema: any) => {
   if (schema.properties) {

package/src/util/uischema.ts

@@ -22,8 +22,9 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
-import { isLayout, UISchemaElement } from '../models/uischema';
+import { isLayout, UISchemaElement } from '../models';
 
 export type IterateCallback = (uischema: UISchemaElement) => void;