@jsonforms/core 2.5.2 → 3.0.0-alpha.3

package/src/util/renderer.ts

@@ -22,11 +22,10 @@
   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 RefParser from 'json-schema-ref-parser';
 import {
   findUISchema,
   getAjv,
@@ -34,48 +33,29 @@ import {
   getConfig,
   getData,
   getErrorAt,
-  getRefParserOptions,
+  getErrorTranslator,
   getRenderers,
   getSchema,
   getSubErrorsAt,
-  getUiSchema
+  getTranslator,
+  getUiSchema,
+  JsonFormsCellRendererRegistryEntry,
+  JsonFormsRendererRegistryEntry,
+  JsonFormsUISchemaRegistryEntry,
 } from '../reducers';
 import { RankedTester } from '../testers';
-import { JsonSchema } from '../models/jsonSchema';
-import {
-  AnyAction,
-  CombinatorKeyword,
-  composePaths,
-  composeWithUi,
-  createLabelDescriptionFrom,
-  Dispatch,
-  formatErrorMessage,
-  hasEnableRule,
-  hasShowRule,
-  isEnabled,
-  isVisible,
-  moveDown,
-  moveUp,
-  Resolve,
-  resolveSubSchemas
-} from '../util';
+import { isInherentlyEnabled, hasShowRule } 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 { isVisible } from './runtime';
 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,
@@ -108,6 +88,7 @@ const isRequired = (
  *
  * @param {string} 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 = (
@@ -118,6 +99,20 @@ export const computeLabel = (
   return required && !hideRequiredAsterisk ? label + '*' : label;
 };
 
+/**
+ * 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;
+};
+
 /**
  * Create a default value based on the given scheam.
  * @param schema the schema for which to create a default value.
@@ -179,16 +174,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 {
   /**
@@ -328,7 +352,7 @@ export interface StatePropsOfControl extends StatePropsOfScopedRenderer {
   /**
    * The label for the rendered element.
    */
-  label: string | Labels;
+  label: string;
 
   /**
    * Description of input cell
@@ -407,11 +431,6 @@ export const mapStateToControlProps = (
     ownProps.visible === undefined || hasShowRule(uischema)
       ? isVisible(uischema, rootData, ownProps.path, getAjv(state))
       : ownProps.visible;
-  const readonly = state.jsonforms.readonly;
-  const enabled: boolean =
-    !readonly && (ownProps.enabled === undefined || hasEnableRule(uischema)
-      ? isEnabled(uischema, rootData, ownProps.path, getAjv(state) )
-      : ownProps.enabled);
   const controlElement = uischema as ControlElement;
   const id = ownProps.id;
   const rootSchema = getSchema(state);
@@ -423,26 +442,42 @@ 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);
   const labelDesc = createLabelDescriptionFrom(uischema, resolvedSchema);
   const label = labelDesc.show ? labelDesc.text : '';
+  const config = getConfig(state);
+  const enabled: boolean = isInherentlyEnabled(
+    state,
+    ownProps,
+    uischema,
+    resolvedSchema || rootSchema,
+    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
@@ -476,9 +511,21 @@ export const mapStateToEnumControlProps = (
 ): StatePropsOfControl & OwnPropsOfEnum => {
   const props: StatePropsOfControl = mapStateToControlProps(state, ownProps);
   const options: EnumOption[] =
-      ownProps.options ||
-      props.schema.enum?.map(enumToEnumOptionMapper) ||
-      props.schema.const && [enumToEnumOptionMapper(props.schema.const)];
+    ownProps.options ||
+    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
@@ -498,7 +545,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
@@ -519,8 +572,21 @@ export const mapStateToMultiEnumControlProps = (
   const items = props.schema.items as JsonSchema;
   const options: EnumOption[] =
     ownProps.options ||
-    (items?.oneOf && (items.oneOf as JsonSchema[]).map(oneOfToEnumOptionMapper)) ||
-    items?.enum?.map(enumToEnumOptionMapper);
+    (items?.oneOf &&
+      (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
@@ -702,14 +768,14 @@ export const mapDispatchToArrayControlProps = (
 });
 
 export interface DispatchPropsOfMultiEnumControl {
-  addItem: (path:string, value: any) => void;
-  removeItem? :(path:string, toDelete: any) => void;
+  addItem: (path: string, value: any) => void;
+  removeItem?: (path: string, toDelete: any) => void;
 }
 
 export const mapDispatchToMultiEnumProps = (
   dispatch: Dispatch<CoreActions>
 ): DispatchPropsOfMultiEnumControl => ({
-  addItem: (path:string, value: any) => {
+  addItem: (path: string, value: any) => {
     dispatch(
       update(path, data => {
         if (data === undefined || data === null) {
@@ -720,7 +786,7 @@ export const mapDispatchToMultiEnumProps = (
       })
     );
   },
-  removeItem: (path:string, toDelete: any) => {
+  removeItem: (path: string, toDelete: any) => {
     dispatch(
       update(path, data => {
         const indexInData = data.indexOf(toDelete);
@@ -776,13 +842,17 @@ export const mapStateToLayoutProps = (
     ownProps.visible === undefined || hasShowRule(uischema)
       ? isVisible(ownProps.uischema, rootData, ownProps.path, getAjv(state))
       : ownProps.visible;
-  const readonly = state.jsonforms.readonly;
-  const enabled: boolean =
-    !readonly && (ownProps.enabled === undefined || hasEnableRule(uischema)
-      ? isEnabled(ownProps.uischema, rootData, ownProps.path, getAjv(state))
-      : ownProps.enabled);
 
   const data = Resolve.data(rootData, ownProps.path);
+  const config = getConfig(state);
+  const enabled: boolean = isInherentlyEnabled(
+    state,
+    ownProps,
+    uischema,
+    undefined, // layouts have no associated schema
+    rootData,
+    config
+  );
 
   return {
     ...layoutDefaultProps,
@@ -805,7 +875,6 @@ export interface OwnPropsOfJsonFormsRenderer extends OwnPropsOfRenderer {}
 export interface StatePropsOfJsonFormsRenderer
   extends OwnPropsOfJsonFormsRenderer {
   rootSchema: JsonSchema;
-  refResolver: any;
 }
 
 export interface JsonFormsProps extends StatePropsOfJsonFormsRenderer {}
@@ -834,8 +903,6 @@ export const mapStateToJsonFormsRendererProps = (
     schema: ownProps.schema || getSchema(state),
     rootSchema: getSchema(state),
     uischema: uischema,
-    refResolver: (schema: any) =>
-      RefParser.dereference(schema, getRefParserOptions(state)),
     path: ownProps.path
   };
 };
@@ -854,7 +921,7 @@ export interface StatePropsOfCombinator extends OwnPropsOfControl {
   data: any;
 }
 
-const mapStateToCombinatorRendererProps = (
+export const mapStateToCombinatorRendererProps = (
   state: JsonFormsState,
   ownProps: OwnPropsOfControl,
   keyword: CombinatorKeyword
@@ -882,7 +949,8 @@ const mapStateToCombinatorRendererProps = (
     'required',
     'additionalProperties',
     'type',
-    'enum'
+    'enum',
+    'const'
   ];
   const dataIsValid = (errors: ErrorObject[]): boolean => {
     return (
@@ -892,12 +960,19 @@ const mapStateToCombinatorRendererProps = (
     );
   };
   let indexOfFittingSchema: number;
+  // TODO instead of compiling the combinator subschemas we can compile the original schema
+  // without the combinator alternatives and then revalidate and check the errors for the
+  // element
   for (let i = 0; i < _schema[keyword].length; i++) {
-    const valFn = ajv.compile(_schema[keyword][i]);
-    valFn(data);
-    if (dataIsValid(valFn.errors)) {
-      indexOfFittingSchema = i;
-      break;
+    try {
+      const valFn = ajv.compile(_schema[keyword][i]);
+      valFn(data);
+      if (dataIsValid(valFn.errors)) {
+        indexOfFittingSchema = i;
+        break;
+      }
+    } catch (error) {
+      console.debug("Combinator subschema is not self contained, can't hand it over to AJV");
     }
   }
 
@@ -967,9 +1042,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' : '') +
@@ -985,8 +1069,6 @@ export const mapStateToArrayLayoutProps = (
   };
 };
 
-export type CombinatorProps = StatePropsOfCombinator & DispatchPropsOfControl;
-
 /**
  * Props of an array control.
  */

package/src/util/resolvers.ts

@@ -22,17 +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 isArray from 'lodash/isArray';
-import isObject from 'lodash/isObject';
-import isFunction from 'lodash/isFunction';
-import isUndefined from 'lodash/isUndefined';
-import forOwn from 'lodash/forOwn';
-import isString from 'lodash/isString';
-import isPlainObject from 'lodash/isPlainObject';
-import { parse } from 'uri-js';
-import { JsonSchema } from '..';
+import { JsonSchema } from '../models';
 
 /**
  * Map for storing refs and the respective schemas they are pointing to.
@@ -194,255 +187,3 @@ function retrieveResolvableSchema(
 
   return child;
 }
-
-// copied and adapted from JsonRefs
-
-/**
- * Interface for describing result of an extracted schema ref
- */
-export interface SchemaRef {
-  uri: string;
-}
-
-/**
- * Interface wraps SchemaRef
- */
-export interface SchemaRefs {
-  [id: string]: SchemaRef;
-}
-
-export const findRefs = (obj: JsonSchema): SchemaRefs => {
-  const refs: SchemaRefs = {};
-
-  // Walk the document (or sub document) and find all JSON References
-  walk([], obj, [], ({}, node: any, path: any) => {
-    let processChildren = true;
-    let refDetails;
-    let refPtr;
-
-    if (isRefLike(node, false)) {
-      refDetails = getRefDetails(node);
-
-      if (refDetails.type !== 'invalid') {
-        refPtr = pathToPtr(path, undefined);
-
-        refs[refPtr] = refDetails;
-      }
-
-      // Whenever a JSON Reference has extra children, its children should not be processed.
-      //   See: http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03#section-3
-      if (getExtraRefKeys(node).length > 0) {
-        processChildren = false;
-      }
-    }
-
-    return processChildren;
-  });
-
-  return refs;
-};
-
-// pure copy of JsonRefs (added types)
-
-const walk = (ancestors: any, node: any, path: any, fn: any) => {
-  let processChildren = true;
-
-  const walkItem = (item: any, segment: any) => {
-    path.push(segment);
-    walk(ancestors, item, path, fn);
-    path.pop();
-  };
-
-  // Call the iteratee
-  if (isFunction(fn)) {
-    processChildren = fn(ancestors, node, path);
-  }
-
-  // We do not process circular objects again
-  if (ancestors.indexOf(node) === -1) {
-    ancestors.push(node);
-
-    if (processChildren !== false) {
-      if (isArray(node)) {
-        node.forEach((member, index) => {
-          walkItem(member, index.toString());
-        });
-      } else if (isObject(node)) {
-        forOwn(node, (cNode, key) => {
-          walkItem(cNode, key);
-        });
-      }
-    }
-
-    ancestors.pop();
-  }
-};
-
-const pathToPtr = (path: any, hashPrefix: any) => {
-  if (!isArray(path)) {
-    throw new Error('path must be an Array');
-  }
-
-  // Encode each segment and return
-  return (
-    (hashPrefix !== false ? '#' : '') +
-    (path.length > 0 ? '/' : '') +
-    encodePath(path).join('/')
-  );
-};
-
-const encodePath = (path: any) => {
-  if (!isArray(path)) {
-    throw new TypeError('path must be an array');
-  }
-
-  return path.map(seg => {
-    if (!isString(seg)) {
-      seg = JSON.stringify(seg);
-    }
-
-    return seg.replace(/~/g, '~0').replace(/\//g, '~1');
-  });
-};
-
-const uriDetailsCache = {} as any;
-const badPtrTokenRegex = /~(?:[^01]|$)/g;
-
-const getRefDetails = (obj: any) => {
-  const details = {
-    def: obj
-  } as any;
-  let cacheKey;
-  let extraKeys;
-  let uriDetails;
-
-  try {
-    if (isRefLike(obj, true)) {
-      cacheKey = obj.$ref;
-      uriDetails = uriDetailsCache[cacheKey];
-
-      if (isUndefined(uriDetails)) {
-        uriDetails = uriDetailsCache[cacheKey] = parseURI(cacheKey);
-      }
-
-      details.uri = cacheKey;
-      details.uriDetails = uriDetails;
-
-      if (isUndefined(uriDetails.error)) {
-        details.type = getRefType(details);
-
-        // Validate the JSON Pointer
-        try {
-          if (['#', '/'].indexOf(cacheKey[0]) > -1) {
-            isPtr(cacheKey, true);
-          } else if (cacheKey.indexOf('#') > -1) {
-            isPtr(uriDetails.fragment, true);
-          }
-        } catch (err) {
-          details.error = err.message;
-          details.type = 'invalid';
-        }
-      } else {
-        details.error = details.uriDetails.error;
-        details.type = 'invalid';
-      }
-
-      // Identify warning
-      extraKeys = getExtraRefKeys(obj);
-
-      if (extraKeys.length > 0) {
-        details.warning =
-          'Extra JSON Reference properties will be ignored: ' +
-          extraKeys.join(', ');
-      }
-    } else {
-      details.type = 'invalid';
-    }
-  } catch (err) {
-    details.error = err.message;
-    details.type = 'invalid';
-  }
-
-  return details;
-};
-
-const getRefType = (refDetails: any) => {
-  let type;
-
-  // Convert the URI reference to one of our types
-  switch (refDetails.uriDetails.reference) {
-    case 'absolute':
-    case 'uri':
-      type = 'remote';
-      break;
-    case 'same-document':
-      type = 'local';
-      break;
-    default:
-      type = refDetails.uriDetails.reference;
-  }
-
-  return type;
-};
-
-const getExtraRefKeys = (ref: any) => {
-  return Object.keys(ref).filter(key => {
-    return key !== '$ref';
-  });
-};
-
-const parseURI = (uri: string) => {
-  // We decode first to avoid doubly encoding
-  return parse(uri);
-};
-
-const isPtr = (ptr: any, throwWithDetails: boolean) => {
-  let valid = true;
-  let firstChar;
-
-  try {
-    if (isString(ptr)) {
-      if (ptr !== '') {
-        firstChar = ptr.charAt(0);
-
-        if (['#', '/'].indexOf(firstChar) === -1) {
-          throw new Error('ptr must start with a / or #/');
-        } else if (firstChar === '#' && ptr !== '#' && ptr.charAt(1) !== '/') {
-          throw new Error('ptr must start with a / or #/');
-        } else if (ptr.match(badPtrTokenRegex)) {
-          throw new Error('ptr has invalid token(s)');
-        }
-      }
-    } else {
-      throw new Error('ptr is not a String');
-    }
-  } catch (err) {
-    if (throwWithDetails === true) {
-      throw err;
-    }
-
-    valid = false;
-  }
-
-  return valid;
-};
-
-const isRefLike = (obj: any, throwWithDetails: boolean) => {
-  let refLike = true;
-
-  try {
-    if (!isPlainObject(obj)) {
-      throw new Error('obj is not an Object');
-    } else if (!isString(obj.$ref)) {
-      throw new Error('obj.$ref is not a String');
-    }
-  } catch (err) {
-    if (throwWithDetails) {
-      throw err;
-    }
-
-    refLike = false;
-  }
-
-  return refLike;
-};