@jsonforms/core 3.0.0-alpha.2 → 3.0.0-alpha.3

package/src/util/renderer.ts

@@ -55,9 +55,7 @@ import { isVisible } from './runtime';
 import { CoreActions, update } from '../actions';
 import { ErrorObject } from 'ajv';
 import { JsonFormsState } from '../store';
-import { getCombinedErrorMessage, getI18nKey, i18nJsonSchema, Translator } from '../i18n';
-
-export { JsonFormsRendererRegistryEntry, JsonFormsCellRendererRegistryEntry };
+import { getCombinedErrorMessage, getI18nKey, getI18nKeyPrefix, Translator } from '../i18n';
 
 const isRequired = (
   schema: JsonSchema,
@@ -195,7 +193,7 @@ export const enumToEnumOptionMapper = (
 export const oneOfToEnumOptionMapper = (
   e: any,
   t?: Translator,
-  uiSchemaI18nKey?: string
+  fallbackI18nKey?: string
 ): EnumOption => {
   let label =
     e.title ??
@@ -204,8 +202,8 @@ export const oneOfToEnumOptionMapper = (
     // prefer schema keys as they can be more specialized
     if (e.i18n) {
       label = t(e.i18n, label);
-    } else if (uiSchemaI18nKey) {
-      label = t(`${uiSchemaI18nKey}.${label}`, label);
+    } else if (fallbackI18nKey) {
+      label = t(`${fallbackI18nKey}.${label}`, label);
     } else {
       label = t(label, label);
     }
@@ -464,9 +462,9 @@ export const mapStateToControlProps = (
   const schema = resolvedSchema ?? rootSchema;
   const t = getTranslator()(state);
   const te = getErrorTranslator()(state);
-  const i18nLabel = t(getI18nKey(schema, uischema, 'label') ?? label, label);
-  const i18nDescription = t(getI18nKey(schema, uischema, 'description') ?? description, description);
-  const i18nErrorMessage = getCombinedErrorMessage(errors, te, t, schema, uischema);
+  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,
@@ -518,14 +516,14 @@ export const mapStateToEnumControlProps = (
       enumToEnumOptionMapper(
         e,
         getTranslator()(state),
-        props.uischema?.options?.i18n ?? (props.schema as i18nJsonSchema).i18n
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
       )
     ) ||
     (props.schema.const && [
       enumToEnumOptionMapper(
         props.schema.const,
         getTranslator()(state),
-        props.uischema?.options?.i18n ?? (props.schema as i18nJsonSchema).i18n
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
       )
     ]);
   return {
@@ -551,7 +549,7 @@ export const mapStateToOneOfEnumControlProps = (
       oneOfToEnumOptionMapper(
         oneOfSubSchema,
         getTranslator()(state),
-        props.uischema?.options?.i18n
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
       )
     );
   return {
@@ -579,14 +577,14 @@ export const mapStateToMultiEnumControlProps = (
         oneOfToEnumOptionMapper(
           oneOfSubSchema,
           state.jsonforms.i18n?.translate,
-          props.uischema?.options?.i18n
+          getI18nKeyPrefix(props.schema, props.uischema, props.path)
         )
       )) ||
     items?.enum?.map(e =>
       enumToEnumOptionMapper(
         e,
         state.jsonforms.i18n?.translate,
-        props.uischema?.options?.i18n ?? (props.schema as i18nJsonSchema).i18n
+        getI18nKeyPrefix(props.schema, props.uischema, props.path)
       )
     );
   return {
@@ -923,7 +921,7 @@ export interface StatePropsOfCombinator extends OwnPropsOfControl {
   data: any;
 }
 
-const mapStateToCombinatorRendererProps = (
+export const mapStateToCombinatorRendererProps = (
   state: JsonFormsState,
   ownProps: OwnPropsOfControl,
   keyword: CombinatorKeyword
@@ -1052,6 +1050,7 @@ export const mapStateToArrayLayoutProps = (
     getErrorTranslator()(state),
     getTranslator()(state),
     undefined,
+    undefined,
     undefined
   );
 

package/test/i18n/i18nUtil.test.ts

@@ -0,0 +1,48 @@
+/*
+  The MIT License
+  
+  Copyright (c) 2017-2021 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 test from 'ava';
+
+import { transformPathToI18nPrefix } from '../../src';
+
+test('transformPathToI18nPrefix returns root when empty', t => {
+  t.is(transformPathToI18nPrefix(''), 'root');
+});
+
+test('transformPathToI18nPrefix does not modify non-array paths', t => {
+  t.is(transformPathToI18nPrefix('foo'), 'foo');
+  t.is(transformPathToI18nPrefix('foo.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('bar3.foo2'), 'bar3.foo2');
+});
+
+test('transformPathToI18nPrefix removes array indices', t => {
+  t.is(transformPathToI18nPrefix('foo.2.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.234324234.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.0.bar'), 'foo.bar');
+  t.is(transformPathToI18nPrefix('foo.0.bar.1.foobar'), 'foo.bar.foobar');
+  t.is(transformPathToI18nPrefix('3.foobar'), 'foobar');
+  t.is(transformPathToI18nPrefix('foobar.3'), 'foobar');
+  t.is(transformPathToI18nPrefix('foo1.23.b2ar3.1.5.foo'), 'foo1.b2ar3.foo');
+  t.is(transformPathToI18nPrefix('3'), 'root');
+});

package/test/reducers/core.test.ts

@@ -25,7 +25,7 @@
 import test from 'ava';
 import Ajv from 'ajv';
 import { coreReducer } from '../../src/reducers';
-import { init, update, updateErrors } from '../../src/actions';
+import { init, setSchema, setValidationMode, update, updateCore, updateErrors } from '../../src/actions';
 import { JsonSchema } from '../../src/models/jsonSchema';
 import {
   errorAt,
@@ -34,9 +34,8 @@ import {
   subErrorsAt
 } from '../../src/reducers/core';
 
-import { createAjv, updateCore } from '../../src';
-import { setSchema, setValidationMode } from '../../lib';
 import { cloneDeep } from 'lodash';
+import { createAjv } from '../../src/util/validator';
 
 test('core reducer should support v7', t => {
   const schema: JsonSchema = {

package/test/util/renderer.test.ts

@@ -23,47 +23,25 @@
   THE SOFTWARE.
 */
 import * as _ from 'lodash';
-import { init, update, UPDATE_DATA, UpdateAction } from '../../src/actions';
 import * as Redux from 'redux';
-import {
-  clearAllIds,
-  computeLabel,
-  createAjv,
-  createDefaultValue,
-  mapDispatchToArrayControlProps,
-  mapDispatchToControlProps,
-  mapStateToArrayLayoutProps,
-  mapStateToControlProps,
-  mapStateToJsonFormsRendererProps,
-  mapStateToLayoutProps,
-  mapStateToOneOfProps,
-  mapStateToMultiEnumControlProps,
-  mapDispatchToMultiEnumProps
-} from '../../src/util';
 import configureStore from 'redux-mock-store';
 import test from 'ava';
-import { generateDefaultUISchema } from '../../src/generators';
-import {
-  ControlElement,
-  CoreActions,
-  coreReducer,
-  Dispatch,
-  JsonFormsCore,
-  JsonFormsState,
-  JsonSchema,
-  JsonSchema7,
-  mapStateToAnyOfProps,
-  OwnPropsOfControl,
-  rankWith,
-  RuleEffect,
-  UISchemaElement,
-  setValidationMode,
-  defaultJsonFormsI18nState,
-  i18nJsonSchema,
-  mapStateToEnumControlProps,
-  mapStateToOneOfEnumControlProps
-} from '../../src';
+
 import { ErrorObject } from 'ajv';
+import { JsonFormsState } from '../../src/store';
+import { coreReducer, JsonFormsCore } from '../../src/reducers/core';
+import { Dispatch } from '../../src/util/type';
+import { CoreActions, init, setValidationMode, update, UpdateAction, UPDATE_DATA } from '../../src/actions/actions';
+import { ControlElement, RuleEffect, UISchemaElement } from '../../src/models/uischema';
+import { computeLabel, createDefaultValue, mapDispatchToArrayControlProps, mapDispatchToControlProps, mapDispatchToMultiEnumProps, mapStateToAnyOfProps, mapStateToArrayLayoutProps, mapStateToControlProps, mapStateToEnumControlProps, mapStateToJsonFormsRendererProps, mapStateToLayoutProps, mapStateToMultiEnumControlProps, mapStateToOneOfEnumControlProps, mapStateToOneOfProps, OwnPropsOfControl } from '../../src/util/renderer';
+import { clearAllIds } from '../../src/util/ids';
+import { generateDefaultUISchema } from '../../src/generators/uischema';
+import { JsonSchema } from '../../src/models/jsonSchema';
+import { rankWith } from '../../src/testers/testers';
+import { createAjv } from '../../src/util/validator';
+import { JsonSchema7 } from '../../src/models/jsonSchema7';
+import { defaultJsonFormsI18nState } from '../../src/reducers/i18n';
+import { i18nJsonSchema } from '../../src/i18n/i18nTypes';
 
 const middlewares: Redux.Middleware[] = [];
 const mockStore = configureStore<JsonFormsState>(middlewares);
@@ -1304,7 +1282,7 @@ test('mapStateToControlProps - i18n - default translation has no effect', t => {
   t.is(props.description, undefined);
 });
 
-test('mapStateToControlProps - i18n - translation via label key', t => {
+test('mapStateToControlProps - i18n - translation via path key', t => {
   const ownProps = {
     uischema: coreUISchema
   };
@@ -1312,6 +1290,24 @@ test('mapStateToControlProps - i18n - translation via label key', t => {
   state.jsonforms.i18n = defaultJsonFormsI18nState;
   state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
     switch(key){
+      case 'firstName.label': return 'my translation';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'my translation');
+  t.is(props.description, undefined);
+});
+
+test('mapStateToControlProps - i18n - translation via default message', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (_key: string, defaultMessage: string | undefined) => {
+    switch(defaultMessage){
       case 'First Name': return 'my translation';
       default: return defaultMessage;
     }
@@ -1601,7 +1597,7 @@ test('mapStateToEnumControlProps - i18n - default translation has no effect', t
   t.is(props.options[0].label, 'a');
 });
 
-test('mapStateToEnumControlProps - i18n - label translation', t => {
+test('mapStateToEnumControlProps - i18n - path label translation', t => {
   const ownProps = {
     uischema: coreUISchema
   };
@@ -1610,6 +1606,24 @@ test('mapStateToEnumControlProps - i18n - label translation', t => {
   state.jsonforms.i18n = defaultJsonFormsI18nState;
   state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
     switch(key){
+      case 'firstName.a': return 'my message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});
+
+test('mapStateToEnumControlProps - i18n - defaultMessage translation', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.enum = ['a', 'b'];
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (_key: string, defaultMessage: string | undefined) => {
+    switch(defaultMessage){
       case 'a': return 'my message';
       default: return defaultMessage;
     }
@@ -1662,7 +1676,7 @@ test('mapStateToOneOfEnumControlProps- i18n - default translation has no effect'
   t.is(props.options[0].label, 'foo');
 });
 
-test('mapStateToOneOfEnumControlProps - i18n - label translation', t => {
+test('mapStateToOneOfEnumControlProps - i18n - path label translation', t => {
   const ownProps = {
     uischema: coreUISchema
   };
@@ -1671,6 +1685,24 @@ test('mapStateToOneOfEnumControlProps - i18n - label translation', t => {
   state.jsonforms.i18n = defaultJsonFormsI18nState;
   state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
     switch(key){
+      case 'firstName.foo': return 'my message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToOneOfEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});
+
+test('mapStateToOneOfEnumControlProps - i18n - default message translation', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.oneOf = [{const: 'a', title: 'foo'}, {const: 'b', title: 'bar'}]
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (_key: string, defaultMessage: string | undefined) => {
+    switch(defaultMessage){
       case 'foo': return 'my message';
       default: return defaultMessage;
     }