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

package/test/util/renderer.test.ts

@@ -23,43 +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
-} from '../../src';
+
 import { ErrorObject } from 'ajv';
-import { setValidationMode } from '../../lib';
+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);
@@ -384,7 +366,7 @@ test('mapStateToControlProps - errors', t => {
   };
   const clonedState = _.cloneDeep(createState(coreUISchema));
   const error: ErrorObject = {
-    dataPath: 'firstName',
+    instancePath: '/firstName',
     message: 'Duff beer',
     keyword: 'whatever',
     schemaPath: '',
@@ -1274,6 +1256,477 @@ test('mapStateToAnyOfProps - const constraint in anyOf schema should return corr
     }
   };
   const props = mapStateToAnyOfProps(state, ownProps);
-  console.log(JSON.stringify(props, null, 2));
   t.is(props.indexOfFittingSchema, 2);
 });
+
+test('mapStateToControlProps - i18n - mapStateToControlProps should not crash without i18n', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.i18n = undefined;
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'First Name');
+});
+
+test('mapStateToControlProps - i18n - default translation has no effect', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'First Name');
+  t.is(props.description, undefined);
+});
+
+test('mapStateToControlProps - i18n - translation via path key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  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;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'my translation');
+  t.is(props.description, undefined);
+});
+
+test('mapStateToControlProps - i18n - translation via JSON Schema i18n key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.label': return 'my label';
+      case 'my-key.description': return 'my description';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'my label');
+  t.is(props.description, 'my description');
+});
+
+test('mapStateToControlProps - i18n - translation via UI Schema i18n key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  ownProps.uischema = {...ownProps.uischema, options: {i18n: 'my-key'}};
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.label': return 'my label';
+      case 'my-key.description': return 'my description';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.label, 'my label');
+  t.is(props.description, 'my description');
+});
+
+test('mapStateToControlProps - i18n errors - should not crash without i18n', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+"
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = undefined;
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'must match pattern "[0-9]+"');
+});
+
+test('mapStateToControlProps - i18n errors - default translation has no effect', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+"
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'must match pattern "[0-9]+"');
+});
+
+test('mapStateToControlProps - i18n errors - translate via error message key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+"
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'must match pattern "[0-9]+"': return 'my error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'my error message');
+});
+
+test('mapStateToControlProps - i18n errors - translate via i18 specialized error keyword key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+";
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.error.pattern': return 'my error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'my error message');
+});
+
+test('mapStateToControlProps - i18n errors - translate via i18 general error keyword key', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+";
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'error.pattern': return 'my error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'my error message');
+});
+
+test('mapStateToControlProps - i18n errors - specialized keyword wins over generic keyword', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+";
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.error.pattern': return 'my key error message';
+      case 'error.pattern': return 'my error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'my key error message');
+});
+
+test('mapStateToControlProps - i18n errors - multiple errors customization', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+";
+  state.jsonforms.core.schema.properties.firstName.maxLength = 2;
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'error.maxLength': return 'max length message';
+      case 'my-key.error.pattern': return 'my key error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'max length message\nmy key error message');
+});
+
+test('mapStateToControlProps - i18n errors - custom keyword wins over all other errors', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.pattern = "[0-9]+";
+  state.jsonforms.core.schema.properties.firstName.maxLength = 2;
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.core = coreReducer(
+    state.jsonforms.core,
+    init(
+      state.jsonforms.core.data,
+      state.jsonforms.core.schema,
+      state.jsonforms.core.uischema,
+      createAjv()
+    )
+  );
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.error.custom': return 'this is my error custom error message';
+      case 'my-key.error.pattern': return 'my key error message';
+      case 'error.pattern': return 'my error message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToControlProps(state, ownProps);
+  t.is(props.errors, 'this is my error custom error message');
+});
+
+test('mapStateToEnumControlProps - i18n - should not crash without i18n', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.enum = ['a', 'b'];
+  state.jsonforms.i18n = undefined;
+
+  const props = mapStateToEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'a');
+});
+
+test('mapStateToEnumControlProps - i18n - default translation has no effect', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.enum = ['a', 'b'];
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+
+  const props = mapStateToEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'a');
+});
+
+test('mapStateToEnumControlProps - i18n - path label 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(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;
+    }
+  }
+
+  const props = mapStateToEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});
+
+test('mapStateToEnumControlProps - i18n - i18n key translation', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  state.jsonforms.core.schema.properties.firstName.enum = ['a', 'b'];
+  (state.jsonforms.core.schema.properties.firstName as i18nJsonSchema).i18n = 'my-key';
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-key.a': return 'my message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});
+
+test('mapStateToOneOfEnumControlProps - i18n - should not crash without i18n', 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 = undefined;
+
+  const props = mapStateToOneOfEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'foo');
+});
+
+test('mapStateToOneOfEnumControlProps- i18n - default translation has no effect', 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;
+
+  const props = mapStateToOneOfEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'foo');
+});
+
+test('mapStateToOneOfEnumControlProps - i18n - path label 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(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;
+    }
+  }
+
+  const props = mapStateToOneOfEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});
+
+test('mapStateToOneOfEnumControlProps - i18n - i18n key translation', t => {
+  const ownProps = {
+    uischema: coreUISchema
+  };
+  const state: JsonFormsState = createState(coreUISchema);
+  (state.jsonforms.core.schema.properties.firstName.oneOf as any) =
+    [{const: 'a', title: 'foo', i18n: 'my-foo'}, {const: 'b', title: 'bar', i18n:'my-bar'}];
+  state.jsonforms.i18n = defaultJsonFormsI18nState;
+  state.jsonforms.i18n.translate = (key: string, defaultMessage: string | undefined) => {
+    switch(key){
+      case 'my-foo': return 'my message';
+      default: return defaultMessage;
+    }
+  }
+
+  const props = mapStateToOneOfEnumControlProps(state, ownProps);
+  t.is(props.options[0].label, 'my message');
+});

package/lib/Helpers.js

@@ -1,32 +0,0 @@
-"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
-  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.
-*/
-Object.defineProperty(exports, "__esModule", { value: true });
-var util_1 = require("./util");
-exports.Helpers = {
-    createLabelDescriptionFrom: util_1.createLabelDescriptionFrom,
-    convertToValidClassName: util_1.convertToValidClassName
-};
-//# sourceMappingURL=Helpers.js.map

package/lib/Helpers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Helpers.js","sourceRoot":"","sources":["../src/Helpers.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;EAuBE;;AAEF,+BAA6E;AAGhE,QAAA,OAAO,GAMhB;IACF,0BAA0B,mCAAA;IAC1B,uBAAuB,gCAAA;CACxB,CAAC"}