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

package/src/reducers/i18n.ts

@@ -22,66 +22,73 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import { SET_LOCALE, SET_LOCALIZED_SCHEMAS } from '../actions';
-import { JsonSchema, SET_LOCALIZED_UISCHEMAS, UISchemaElement } from '..';
-import { Reducer } from '../util/type';
 
-export interface JsonFormsLocaleState {
-  locale?: string;
-  localizedSchemas: Map<string, JsonSchema>;
-  localizedUISchemas: Map<string, UISchemaElement>;
-}
+import { defaultErrorTranslator, defaultTranslator, JsonFormsI18nState } from '../i18n';
+import { I18nActions, SET_LOCALE, SET_TRANSLATOR, UPDATE_I18N } from '../actions';
+import { Reducer } from '../util';
 
-const initState: JsonFormsLocaleState = {
-  locale: undefined,
-  localizedSchemas: new Map(),
-  localizedUISchemas: new Map()
+export const defaultJsonFormsI18nState: JsonFormsI18nState = {
+  locale: 'en',
+  translate: defaultTranslator,
+  translateError: defaultErrorTranslator
 };
 
-export const i18nReducer: Reducer<any, any> = (state = initState, action) => {
+export const i18nReducer: Reducer<JsonFormsI18nState, I18nActions> = (state = defaultJsonFormsI18nState, action) => {
   switch (action.type) {
-    case SET_LOCALIZED_SCHEMAS:
-      return {
-        ...state,
-        localizedSchemas: action.localizedSchemas
-      };
-    case SET_LOCALIZED_UISCHEMAS:
+    case UPDATE_I18N: {
+      const locale = action.locale ?? defaultJsonFormsI18nState.locale;
+      const translate =
+        action.translator ?? defaultJsonFormsI18nState.translate;
+      const translateError =
+        action.errorTranslator ?? defaultJsonFormsI18nState.translateError;
+
+      if (
+        locale !== state.locale ||
+        translate !== state.translate ||
+        translateError !== state.translateError
+      ) {
+        return {
+          ...state,
+          locale,
+          translate,
+          translateError
+        };
+      }
+      return state;
+    }
+    case SET_TRANSLATOR:
       return {
         ...state,
-        localizedUISchemas: action.localizedUISchemas
+        translate: action.translator ?? defaultTranslator,
+        translateError: action.errorTranslator ?? defaultErrorTranslator
       };
     case SET_LOCALE:
       return {
         ...state,
-        locale:
-          action.locale === undefined ? navigator.languages[0] : action.locale
+        locale: action.locale ?? navigator.languages[0]
       };
     default:
       return state;
   }
 };
 
-export const fetchLocale = (state?: JsonFormsLocaleState) => {
+export const fetchLocale = (state?: JsonFormsI18nState) => {
   if (state === undefined) {
     return undefined;
   }
   return state.locale;
 };
 
-export const findLocalizedSchema = (locale: string) => (
-  state?: JsonFormsLocaleState
-): JsonSchema => {
+export const fetchTranslator = (state?: JsonFormsI18nState) => {
   if (state === undefined) {
-    return undefined;
+    return defaultTranslator;
   }
-  return state.localizedSchemas.get(locale);
-};
+  return state.translate;
+}
 
-export const findLocalizedUISchema = (locale: string) => (
-  state?: JsonFormsLocaleState
-): UISchemaElement => {
+export const fetchErrorTranslator = (state?: JsonFormsI18nState) => {
   if (state === undefined) {
-    return undefined;
+    return defaultErrorTranslator;
   }
-  return state.localizedUISchemas.get(locale);
-};
+  return state.translateError;
+}

package/src/reducers/index.ts

@@ -22,158 +22,13 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import { ControlElement, UISchemaElement } from '../models/uischema';
-import {
-  coreReducer,
-  errorAt,
-  errorsAt,
-  extractAjv,
-  extractData,
-  extractSchema,
-  extractUiSchema,
-  JsonFormsCore,
-  subErrorsAt,
-  ValidationMode
-} from './core';
-import {
-  extractDefaultData,
-  JsonFormsDefaultDataRegistryEntry
-} from './default-data';
-import { defaultDataReducer } from '../reducers/default-data';
-import { JsonFormsRendererRegistryEntry, rendererReducer } from './renderers';
-import { JsonFormsState } from '../store';
-import {
-  findMatchingUISchema,
-  JsonFormsUISchemaRegistryEntry,
-  uischemaRegistryReducer,
-  UISchemaTester
-} from './uischemas';
-import {
-  fetchLocale,
-  findLocalizedSchema,
-  findLocalizedUISchema,
-  i18nReducer
-} from './i18n';
 
-import { Generate } from '../generators';
-import { JsonFormsCellRendererRegistryEntry } from './cells';
-import { JsonSchema } from '../models/jsonSchema';
-
-import { cellReducer } from './cells';
-import { configReducer } from './config';
-import get from 'lodash/get';
-import { Ajv } from 'ajv';
-
-export {
-  rendererReducer,
-  cellReducer,
-  coreReducer,
-  i18nReducer,
-  configReducer,
-  UISchemaTester,
-  uischemaRegistryReducer,
-  findMatchingUISchema,
-  JsonFormsUISchemaRegistryEntry
-};
-export { JsonFormsCore, ValidationMode };
-
-export const jsonFormsReducerConfig = {
-  core: coreReducer,
-  renderers: rendererReducer,
-  cells: cellReducer,
-  config: configReducer,
-  uischemas: uischemaRegistryReducer,
-  defaultData: defaultDataReducer,
-  i18n: i18nReducer
-};
-
-export const getData = (state: JsonFormsState) =>
-  extractData(get(state, 'jsonforms.core'));
-export const getSchema = (state: JsonFormsState): JsonSchema =>
-  extractSchema(get(state, 'jsonforms.core'));
-export const getUiSchema = (state: JsonFormsState): UISchemaElement =>
-  extractUiSchema(get(state, 'jsonforms.core'));
-export const getAjv = (
-  state: JsonFormsState
-): Ajv => extractAjv(get(state, 'jsonforms.core'));
-export const getDefaultData = (
-  state: JsonFormsState
-): JsonFormsDefaultDataRegistryEntry[] =>
-  extractDefaultData(get(state, 'jsonforms.defaultData'));
-export const getRenderers = (
-  state: JsonFormsState
-): JsonFormsRendererRegistryEntry[] => get(state, 'jsonforms.renderers');
-export const getCells = (
-  state: JsonFormsState
-): JsonFormsCellRendererRegistryEntry[] => get(state, 'jsonforms.cells');
-export const getUISchemas = (
-  state: JsonFormsState
-): JsonFormsUISchemaRegistryEntry[] => get(state, 'jsonforms.uischemas');
-
-/**
- * Finds a registered UI schema to use, if any.
- * @param schema the JSON schema describing the data to be rendered
- * @param schemaPath the according schema path
- * @param path the instance path
- * @param fallbackLayoutType the type of the layout to use
- * @param control may be checked for embedded inline uischema options
- */
-export const findUISchema = (
-  uischemas: JsonFormsUISchemaRegistryEntry[],
-  schema: JsonSchema,
-  schemaPath: string,
-  path: string,
-  fallbackLayoutType = 'VerticalLayout',
-  control?: ControlElement,
-  rootSchema?: JsonSchema
-): UISchemaElement => {
-  // handle options
-  if (control && control.options && control.options.detail) {
-    if (typeof control.options.detail === 'string') {
-      if (control.options.detail.toUpperCase() === 'GENERATE') {
-        // force generation of uischema
-        return Generate.uiSchema(schema, fallbackLayoutType);
-      }
-    } else if (typeof control.options.detail === 'object') {
-      // check if detail is a valid uischema
-      if (
-        control.options.detail.type &&
-        typeof control.options.detail.type === 'string'
-      ) {
-        return control.options.detail as UISchemaElement;
-      }
-    }
-  }
-  // default
-  const uiSchema = findMatchingUISchema(uischemas)(schema, schemaPath, path);
-  if (uiSchema === undefined) {
-    return Generate.uiSchema(schema, fallbackLayoutType, '#', rootSchema);
-  }
-  return uiSchema;
-};
-
-export const getErrorAt = (instancePath: string, schema: JsonSchema) => (
-  state: JsonFormsState
-) => {
-  return errorAt(instancePath, schema)(state.jsonforms.core);
-};
-
-export { errorsAt };
-
-export const getSubErrorsAt = (instancePath: string, schema: JsonSchema) => (
-  state: JsonFormsState
-) => subErrorsAt(instancePath, schema)(state.jsonforms.core);
-
-export const getConfig = (state: JsonFormsState) => state.jsonforms.config;
-
-export const getLocale = (state: JsonFormsState) =>
-  fetchLocale(get(state, 'jsonforms.i18n'));
-
-export const getLocalizedSchema = (locale: string) => (
-  state: JsonFormsState
-): JsonSchema => findLocalizedSchema(locale)(get(state, 'jsonforms.i18n'));
-
-export const getLocalizedUISchema = (locale: string) => (
-  state: JsonFormsState
-): UISchemaElement =>
-  findLocalizedUISchema(locale)(get(state, 'jsonforms.i18n'));
+export * from './cells';
+export * from './config';
+export * from './core';
+export * from './default-data';
+export * from './i18n';
+export * from './reducers';
+export * from './renderers';
+export * from './selectors';
+export * from './uischemas';

package/src/reducers/reducers.ts

@@ -0,0 +1,128 @@
+/*
+  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 { ControlElement, UISchemaElement } from '../models';
+import {
+  coreReducer,
+  errorAt,
+  subErrorsAt,
+} from './core';
+import { defaultDataReducer } from './default-data';
+import { rendererReducer } from './renderers';
+import { JsonFormsState } from '../store';
+import type { JsonFormsUISchemaRegistryEntry } from './uischemas';
+import {
+  findMatchingUISchema,
+  uischemaRegistryReducer,
+} from './uischemas';
+import {
+  fetchErrorTranslator,
+  fetchLocale,
+  i18nReducer,
+} from './i18n';
+
+import { Generate } from '../generators';
+import { JsonSchema } from '../models/jsonSchema';
+
+import { cellReducer } from './cells';
+import { configReducer } from './config';
+import get from 'lodash/get';
+import { fetchTranslator } from '.';
+import { ErrorTranslator, Translator } from '../i18n';
+
+export const jsonFormsReducerConfig = {
+  core: coreReducer,
+  renderers: rendererReducer,
+  cells: cellReducer,
+  config: configReducer,
+  uischemas: uischemaRegistryReducer,
+  defaultData: defaultDataReducer,
+  i18n: i18nReducer,
+};
+
+/**
+ * Finds a registered UI schema to use, if any.
+ * @param schema the JSON schema describing the data to be rendered
+ * @param schemaPath the according schema path
+ * @param path the instance path
+ * @param fallbackLayoutType the type of the layout to use
+ * @param control may be checked for embedded inline uischema options
+ */
+export const findUISchema = (
+  uischemas: JsonFormsUISchemaRegistryEntry[],
+  schema: JsonSchema,
+  schemaPath: string,
+  path: string,
+  fallbackLayoutType = 'VerticalLayout',
+  control?: ControlElement,
+  rootSchema?: JsonSchema
+): UISchemaElement => {
+  // handle options
+  if (control && control.options && control.options.detail) {
+    if (typeof control.options.detail === 'string') {
+      if (control.options.detail.toUpperCase() === 'GENERATE') {
+        // force generation of uischema
+        return Generate.uiSchema(schema, fallbackLayoutType);
+      }
+    } else if (typeof control.options.detail === 'object') {
+      // check if detail is a valid uischema
+      if (
+        control.options.detail.type &&
+        typeof control.options.detail.type === 'string'
+      ) {
+        return control.options.detail as UISchemaElement;
+      }
+    }
+  }
+  // default
+  const uiSchema = findMatchingUISchema(uischemas)(schema, schemaPath, path);
+  if (uiSchema === undefined) {
+    return Generate.uiSchema(schema, fallbackLayoutType, '#', rootSchema);
+  }
+  return uiSchema;
+};
+
+export const getErrorAt = (instancePath: string, schema: JsonSchema) => (
+  state: JsonFormsState
+) => {
+  return errorAt(instancePath, schema)(state.jsonforms.core);
+};
+
+export const getSubErrorsAt = (instancePath: string, schema: JsonSchema) => (
+  state: JsonFormsState
+) => subErrorsAt(instancePath, schema)(state.jsonforms.core);
+
+export const getConfig = (state: JsonFormsState) => state.jsonforms.config;
+
+export const getLocale = (state: JsonFormsState) =>
+  fetchLocale(get(state, 'jsonforms.i18n'));
+
+export const getTranslator = () => (
+  state: JsonFormsState
+): Translator => fetchTranslator(get(state, 'jsonforms.i18n'));
+
+export const getErrorTranslator = () => (
+  state: JsonFormsState
+): ErrorTranslator => fetchErrorTranslator(get(state, 'jsonforms.i18n'));

package/src/reducers/renderers.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_RENDERER,
@@ -29,7 +30,7 @@ import {
   REMOVE_RENDERER,
   RemoveRendererAction
 } from '../actions';
-import { Reducer } from '../util/type';
+import { Reducer } from '../util';
 
 export interface JsonFormsRendererRegistryEntry {
   tester: RankedTester;

package/src/reducers/selectors.ts

@@ -0,0 +1,65 @@
+/*
+  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 get from 'lodash/get';
+import Ajv from 'ajv';
+import { JsonFormsState } from '../store';
+import { JsonSchema, UISchemaElement } from '../models';
+import {
+  extractAjv,
+  extractData,
+  extractSchema,
+  extractUiSchema,
+} from './core';
+import {
+  extractDefaultData,
+  JsonFormsDefaultDataRegistryEntry
+} from './default-data';
+import { JsonFormsRendererRegistryEntry } from './renderers';
+import { JsonFormsCellRendererRegistryEntry } from './cells';
+import { JsonFormsUISchemaRegistryEntry } from './uischemas';
+
+export const getData = (state: JsonFormsState) =>
+  extractData(get(state, 'jsonforms.core'));
+export const getSchema = (state: JsonFormsState): JsonSchema =>
+  extractSchema(get(state, 'jsonforms.core'));
+export const getUiSchema = (state: JsonFormsState): UISchemaElement =>
+  extractUiSchema(get(state, 'jsonforms.core'));
+export const getAjv = (
+  state: JsonFormsState
+): Ajv => extractAjv(get(state, 'jsonforms.core'));
+export const getDefaultData = (
+  state: JsonFormsState
+): JsonFormsDefaultDataRegistryEntry[] =>
+  extractDefaultData(get(state, 'jsonforms.defaultData'));
+export const getRenderers = (
+  state: JsonFormsState
+): JsonFormsRendererRegistryEntry[] => get(state, 'jsonforms.renderers');
+export const getCells = (
+  state: JsonFormsState
+): JsonFormsCellRendererRegistryEntry[] => get(state, 'jsonforms.cells');
+export const getUISchemas = (
+  state: JsonFormsState
+): JsonFormsUISchemaRegistryEntry[] => get(state, 'jsonforms.uischemas')

package/src/reducers/uischemas.ts

@@ -22,11 +22,13 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import maxBy from 'lodash/maxBy';
 import remove from 'lodash/remove';
 import { ADD_UI_SCHEMA, REMOVE_UI_SCHEMA, UISchemaActions } from '../actions';
-import { JsonSchema, NOT_APPLICABLE, UISchemaElement } from '..';
-import { Reducer } from '../util/type';
+import { NOT_APPLICABLE } from '../testers';
+import { JsonSchema, UISchemaElement } from '../models';
+import { Reducer } from '../util';
 
 export type UISchemaTester = (
   schema: JsonSchema,

package/src/store.ts

@@ -22,12 +22,15 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { Store } from './util';
-import { JsonFormsCore } from './reducers/core';
-import { JsonFormsCellRendererRegistryEntry } from './reducers/cells';
-import { JsonFormsRendererRegistryEntry } from './reducers/renderers';
-import { JsonFormsLocaleState } from './reducers/i18n';
-import { JsonFormsUISchemaRegistryEntry } from './reducers/uischemas';
+import {
+  JsonFormsCore,
+  JsonFormsCellRendererRegistryEntry,
+  JsonFormsRendererRegistryEntry,
+  JsonFormsUISchemaRegistryEntry
+} from './reducers';
+import { JsonFormsI18nState } from './i18n';
 
 /**
  * JSONForms store.
@@ -62,11 +65,11 @@ export interface JsonFormsSubStates {
    */
   cells?: JsonFormsCellRendererRegistryEntry[];
   /**
-   *
+   * I18n settings.
    */
-  i18n?: JsonFormsLocaleState;
+  i18n?: JsonFormsI18nState;
   /**
-   *
+   * The UI schema registry used in detail renderers.
    */
   uischemas?: JsonFormsUISchemaRegistryEntry[];
   /**