@jsonforms/core 2.5.2 → 3.0.0-alpha.3

package/src/actions/index.ts

@@ -22,316 +22,5 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import AJV, { ErrorObject } from 'ajv';
-import { JsonSchema, UISchemaElement } from '../';
-import { generateDefaultUISchema, generateJsonSchema } from '../generators';
 
-import { RankedTester } from '../testers';
-import RefParser from 'json-schema-ref-parser';
-import { UISchemaTester } from '../reducers/uischemas';
-import { ValidationMode } from '../reducers/core';
-
-export const INIT: 'jsonforms/INIT' = 'jsonforms/INIT';
-export const UPDATE_CORE: 'jsonforms/UPDATE_CORE' = `jsonforms/UPDATE_CORE`;
-export const SET_AJV: 'jsonforms/SET_AJV' = 'jsonforms/SET_AJV';
-export const UPDATE_DATA: 'jsonforms/UPDATE' = 'jsonforms/UPDATE';
-export const UPDATE_ERRORS: 'jsonforms/UPDATE_ERRORS' =
-  'jsonforms/UPDATE_ERRORS';
-export const VALIDATE: 'jsonforms/VALIDATE' = 'jsonforms/VALIDATE';
-export const ADD_RENDERER: 'jsonforms/ADD_RENDERER' = 'jsonforms/ADD_RENDERER';
-export const REMOVE_RENDERER: 'jsonforms/REMOVE_RENDERER' =
-  'jsonforms/REMOVE_RENDERER';
-export const ADD_CELL: 'jsonforms/ADD_CELL' = 'jsonforms/ADD_CELL';
-export const REMOVE_CELL: 'jsonforms/REMOVE_CELL' = 'jsonforms/REMOVE_CELL';
-export const SET_CONFIG: 'jsonforms/SET_CONFIG' = 'jsonforms/SET_CONFIG';
-export const ADD_UI_SCHEMA: 'jsonforms/ADD_UI_SCHEMA' = `jsonforms/ADD_UI_SCHEMA`;
-export const REMOVE_UI_SCHEMA: 'jsonforms/REMOVE_UI_SCHEMA' = `jsonforms/REMOVE_UI_SCHEMA`;
-export const SET_SCHEMA: 'jsonforms/SET_SCHEMA' = `jsonforms/SET_SCHEMA`;
-export const SET_UISCHEMA: 'jsonforms/SET_UISCHEMA' = `jsonforms/SET_UISCHEMA`;
-export const SET_VALIDATION_MODE: 'jsonforms/SET_VALIDATION_MODE' =
-  'jsonforms/SET_VALIDATION_MODE';
-
-export const SET_LOCALE: 'jsonforms/SET_LOCALE' = `jsonforms/SET_LOCALE`;
-export const SET_LOCALIZED_SCHEMAS: 'jsonforms/SET_LOCALIZED_SCHEMAS' =
-  'jsonforms/SET_LOCALIZED_SCHEMAS';
-export const SET_LOCALIZED_UISCHEMAS: 'jsonforms/SET_LOCALIZED_UISCHEMAS' =
-  'jsonforms/SET_LOCALIZED_UISCHEMAS';
-
-export const ADD_DEFAULT_DATA: 'jsonforms/ADD_DEFAULT_DATA' = `jsonforms/ADD_DEFAULT_DATA`;
-export const REMOVE_DEFAULT_DATA: 'jsonforms/REMOVE_DEFAULT_DATA' = `jsonforms/REMOVE_DEFAULT_DATA`;
-
-export type CoreActions =
-  | InitAction
-  | UpdateCoreAction
-  | UpdateAction
-  | UpdateErrorsAction
-  | SetAjvAction
-  | SetSchemaAction
-  | SetUISchemaAction
-  | SetValidationModeAction;
-
-export interface UpdateAction {
-  type: 'jsonforms/UPDATE';
-  path: string;
-  updater(existingData?: any): any;
-}
-
-export interface UpdateErrorsAction {
-  type: 'jsonforms/UPDATE_ERRORS';
-  errors: ErrorObject[];
-}
-
-export interface InitAction {
-  type: 'jsonforms/INIT';
-  data: any;
-  schema: JsonSchema;
-  uischema: UISchemaElement;
-  options?: InitActionOptions | AJV.Ajv;
-}
-
-export interface UpdateCoreAction {
-  type: 'jsonforms/UPDATE_CORE';
-  data?: any;
-  schema?: JsonSchema;
-  uischema?: UISchemaElement;
-  options?: InitActionOptions | AJV.Ajv;
-}
-
-export interface InitActionOptions {
-  ajv?: AJV.Ajv;
-  refParserOptions?: RefParser.Options;
-  validationMode?: ValidationMode;
-}
-
-export interface SetValidationModeAction {
-  type: 'jsonforms/SET_VALIDATION_MODE'
-  validationMode: ValidationMode
-}
-
-export const init = (
-  data: any,
-  schema: JsonSchema = generateJsonSchema(data),
-  uischema?: UISchemaElement,
-  options?: InitActionOptions | AJV.Ajv
-) => ({
-  type: INIT,
-  data,
-  schema,
-  uischema:
-    typeof uischema === 'object' ? uischema : generateDefaultUISchema(schema),
-  options
-});
-
-export const updateCore = (
-  data: any,
-  schema: JsonSchema,
-  uischema?: UISchemaElement,
-  options?: AJV.Ajv | InitActionOptions
-): UpdateCoreAction => ({
-  type: UPDATE_CORE,
-  data,
-  schema,
-  uischema,
-  options
-});
-
-export interface RegisterDefaultDataAction {
-  type: 'jsonforms/ADD_DEFAULT_DATA';
-  schemaPath: string;
-  data: any;
-}
-
-export const registerDefaultData = (schemaPath: string, data: any) => ({
-  type: ADD_DEFAULT_DATA,
-  schemaPath,
-  data
-});
-
-export interface UnregisterDefaultDataAction {
-  type: 'jsonforms/REMOVE_DEFAULT_DATA';
-  schemaPath: string;
-}
-
-export const unregisterDefaultData = (schemaPath: string) => ({
-  type: REMOVE_DEFAULT_DATA,
-  schemaPath
-});
-
-export interface SetAjvAction {
-  type: 'jsonforms/SET_AJV';
-  ajv: AJV.Ajv;
-}
-
-export const setAjv = (ajv: AJV.Ajv) => ({
-  type: SET_AJV,
-  ajv
-});
-
-export const update = (
-  path: string,
-  updater: (existingData: any) => any
-): UpdateAction => ({
-  type: UPDATE_DATA,
-  path,
-  updater
-});
-
-export const updateErrors = (errors: ErrorObject[]): UpdateErrorsAction => ({
-  type: UPDATE_ERRORS,
-  errors
-});
-
-export interface AddRendererAction {
-  type: 'jsonforms/ADD_RENDERER';
-  tester: RankedTester;
-  renderer: any;
-}
-
-export const registerRenderer = (tester: RankedTester, renderer: any) => ({
-  type: ADD_RENDERER,
-  tester,
-  renderer
-});
-
-export interface AddCellRendererAction {
-  type: 'jsonforms/ADD_CELL';
-  tester: RankedTester;
-  cell: any;
-}
-
-export const registerCell = (tester: RankedTester, cell: any) => ({
-  type: ADD_CELL,
-  tester,
-  cell
-});
-
-export interface RemoveCellRendererAction {
-  type: 'jsonforms/REMOVE_CELL';
-  tester: RankedTester;
-  cell: any;
-}
-
-export const unregisterCell = (tester: RankedTester, cell: any) => ({
-  type: REMOVE_CELL,
-  tester,
-  cell
-});
-
-export interface RemoveRendererAction {
-  type: 'jsonforms/REMOVE_RENDERER';
-  tester: RankedTester;
-  renderer: any;
-}
-
-export const unregisterRenderer = (tester: RankedTester, renderer: any) => ({
-  type: REMOVE_RENDERER,
-  tester,
-  renderer
-});
-
-export interface SetConfigAction {
-  type: 'jsonforms/SET_CONFIG';
-  config: any;
-}
-
-export const setConfig = (config: any): SetConfigAction => ({
-  type: SET_CONFIG,
-  config
-});
-
-export const setValidationMode = (validationMode: ValidationMode): SetValidationModeAction => ({
-  type: SET_VALIDATION_MODE,
-  validationMode
-})
-
-export type UISchemaActions = AddUISchemaAction | RemoveUISchemaAction;
-
-export interface AddUISchemaAction {
-  type: 'jsonforms/ADD_UI_SCHEMA';
-  tester: UISchemaTester;
-  uischema: UISchemaElement;
-}
-
-export const registerUISchema = (
-  tester: UISchemaTester,
-  uischema: UISchemaElement
-): AddUISchemaAction => {
-  return {
-    type: ADD_UI_SCHEMA,
-    tester,
-    uischema
-  };
-};
-
-export interface RemoveUISchemaAction {
-  type: 'jsonforms/REMOVE_UI_SCHEMA';
-  tester: UISchemaTester;
-}
-
-export const unregisterUISchema = (
-  tester: UISchemaTester
-): RemoveUISchemaAction => {
-  return {
-    type: REMOVE_UI_SCHEMA,
-    tester
-  };
-};
-
-export type LocaleActions =
-  | SetLocaleAction
-  | SetLocalizedSchemasAction
-  | SetLocalizedUISchemasAction;
-
-export interface SetLocaleAction {
-  type: 'jsonforms/SET_LOCALE';
-  locale: string;
-}
-
-export const setLocale = (locale: string): SetLocaleAction => ({
-  type: SET_LOCALE,
-  locale
-});
-
-export interface SetLocalizedSchemasAction {
-  type: 'jsonforms/SET_LOCALIZED_SCHEMAS';
-  localizedSchemas: Map<string, JsonSchema>;
-}
-
-export const setLocalizedSchemas = (
-  localizedSchemas: Map<string, JsonSchema>
-): SetLocalizedSchemasAction => ({
-  type: SET_LOCALIZED_SCHEMAS,
-  localizedSchemas
-});
-
-export interface SetSchemaAction {
-  type: 'jsonforms/SET_SCHEMA';
-  schema: JsonSchema;
-}
-
-export const setSchema = (schema: JsonSchema): SetSchemaAction => ({
-  type: SET_SCHEMA,
-  schema
-});
-
-export interface SetLocalizedUISchemasAction {
-  type: 'jsonforms/SET_LOCALIZED_UISCHEMAS';
-  localizedUISchemas: Map<string, UISchemaElement>;
-}
-
-export const setLocalizedUISchemas = (
-  localizedUISchemas: Map<string, UISchemaElement>
-): SetLocalizedUISchemasAction => ({
-  type: SET_LOCALIZED_UISCHEMAS,
-  localizedUISchemas
-});
-
-export interface SetUISchemaAction {
-  type: 'jsonforms/SET_UISCHEMA';
-  uischema: UISchemaElement;
-}
-
-export const setUISchema = (uischema: UISchemaElement): SetUISchemaAction => ({
-  type: SET_UISCHEMA,
-  uischema
-});
+export * from './actions';

package/src/configDefault.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 export const configDefault = {
   /*
    * [text] whether to restrict the number of characters to maxLength,

package/src/generators/Generate.ts

@@ -0,0 +1,43 @@
+/*
+  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 { generateJsonSchema } from './schema';
+import { createControlElement, generateDefaultUISchema } from './uischema';
+import { ControlElement, JsonSchema, UISchemaElement } from '../';
+
+export const Generate: {
+  jsonSchema(instance: Object, options?: any): JsonSchema;
+  uiSchema(
+    jsonSchema: JsonSchema,
+    layoutType?: string,
+    prefix?: string,
+    rootSchema?: JsonSchema
+  ): UISchemaElement;
+  controlElement(ref: string): ControlElement;
+} = {
+  jsonSchema: generateJsonSchema,
+  uiSchema: generateDefaultUISchema,
+  controlElement: createControlElement
+};

package/src/generators/index.ts

@@ -22,25 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-import { ControlElement, JsonSchema, UISchemaElement } from '../';
 
-import { generateJsonSchema } from './schema';
-import { createControlElement, generateDefaultUISchema } from './uischema';
-
-export const Generate: {
-  jsonSchema(instance: Object, options?: any): JsonSchema;
-  uiSchema(
-    jsonSchema: JsonSchema,
-    layoutType?: string,
-    prefix?: string,
-    rootSchema?: JsonSchema
-  ): UISchemaElement;
-  controlElement(ref: string): ControlElement;
-} = {
-  jsonSchema: generateJsonSchema,
-  uiSchema: generateDefaultUISchema,
-  controlElement: createControlElement
-};
-
-export { generateJsonSchema };
-export { generateDefaultUISchema };
+export * from './Generate';
+export * from './schema';
+export * from './uischema';

package/src/generators/schema.ts

@@ -23,7 +23,7 @@
   THE SOFTWARE.
 */
 
-import { JsonSchema4 } from '../models/jsonSchema4';
+import { JsonSchema4 } from '../models';
 
 const ADDITIONAL_PROPERTIES = 'additionalProperties';
 const REQUIRED_PROPERTIES = 'required';

package/src/generators/uischema.ts

@@ -22,20 +22,20 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import isEmpty from 'lodash/isEmpty';
 import startCase from 'lodash/startCase';
 import keys from 'lodash/keys';
-import { JsonSchema } from '../models/jsonSchema';
 import {
   ControlElement,
   isGroup,
   isLayout,
+  JsonSchema,
   LabelElement,
   Layout,
   UISchemaElement
-} from '../models/uischema';
-import { resolveSchema } from '../util/resolvers';
-import { deriveTypes } from '../util';
+} from '../models';
+import { deriveTypes, resolveSchema } from '../util';
 
 /**
  * Creates a new ILayout.

package/src/i18n/i18nTypes.ts

@@ -0,0 +1,17 @@
+import { ErrorObject } from 'ajv';
+import { JsonSchema, UISchemaElement } from '../models';
+
+export type Translator = {
+    (id: string, defaultMessage: string, values?: any): string;
+    (id: string, defaultMessage: undefined, values?: any): string | undefined;
+}
+
+export type ErrorTranslator = (error: ErrorObject, translate: Translator, uischema?: UISchemaElement) => string;
+
+export interface JsonFormsI18nState {
+  locale?: string;
+  translate?: Translator;
+  translateError?: ErrorTranslator;
+}
+
+export type i18nJsonSchema = JsonSchema & {i18n?: string};

package/src/i18n/i18nUtil.ts

@@ -0,0 +1,105 @@
+import { ErrorObject } from 'ajv';
+import { UISchemaElement } from '../models';
+import { getControlPath } from '../reducers';
+import { formatErrorMessage } from '../util';
+import { i18nJsonSchema, ErrorTranslator, Translator } from './i18nTypes';
+
+export const getI18nKeyPrefixBySchema = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined
+): string | undefined => {
+  return uischema?.options?.i18n ?? schema?.i18n ?? undefined;
+};
+
+/**
+ * Transforms a given path to a prefix which can be used for i18n keys.
+ * Returns 'root' for empty paths and removes array indices
+ */
+export const transformPathToI18nPrefix = (path: string) => {
+  return (
+    path
+      ?.split('.')
+      .filter(segment => !/^\d+$/.test(segment))
+      .join('.') || 'root'
+  );
+};
+
+export const getI18nKeyPrefix = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined,
+  path: string | undefined
+): string | undefined => {
+  return (
+    getI18nKeyPrefixBySchema(schema, uischema) ??
+    transformPathToI18nPrefix(path)
+  );
+};
+
+export const getI18nKey = (
+  schema: i18nJsonSchema | undefined,
+  uischema: UISchemaElement | undefined,
+  path: string | undefined,
+  key: string
+): string | undefined => {
+  return `${getI18nKeyPrefix(schema, uischema, path)}.${key}`;
+};
+
+export const defaultTranslator: Translator = (_id: string, defaultMessage: string | undefined) => defaultMessage;
+
+export const defaultErrorTranslator: ErrorTranslator = (error, t, uischema) => {
+  // check whether there is a special keyword message
+  const i18nKey = getI18nKey(
+    error.parentSchema,
+    uischema,
+    getControlPath(error),
+    `error.${error.keyword}`
+  );
+  const specializedKeywordMessage = t(i18nKey, undefined);
+  if (specializedKeywordMessage !== undefined) {
+    return specializedKeywordMessage;
+  }
+
+  // check whether there is a generic keyword message
+  const genericKeywordMessage = t(`error.${error.keyword}`, undefined);
+  if (genericKeywordMessage !== undefined) {
+    return genericKeywordMessage;
+  }
+
+  // check whether there is a customization for the default message
+  const messageCustomization = t(error.message, undefined);
+  if (messageCustomization !== undefined) {
+    return messageCustomization;
+  }
+
+  // rewrite required property messages (if they were not customized) as we place them next to the respective input
+  if (error.keyword === 'required' && error.message?.startsWith('must have required property')) {
+    return t('is a required property', 'is a required property');
+  }
+
+  return error.message;
+};
+
+/**
+ * Returns the determined error message for the given errors.
+ * All errors must correspond to the given schema, uischema or path.
+ */
+export const getCombinedErrorMessage = (
+  errors: ErrorObject[],
+  et: ErrorTranslator,
+  t: Translator,
+  schema?: i18nJsonSchema,
+  uischema?: UISchemaElement,
+  path?: string
+) => {
+  if (errors.length > 0 && t) {
+    // check whether there is a special message which overwrites all others
+    const customErrorKey = getI18nKey(schema, uischema, path, 'error.custom');
+    const specializedErrorMessage = t(customErrorKey, undefined);
+    if (specializedErrorMessage !== undefined) {
+      return specializedErrorMessage;
+    }
+  }
+  return formatErrorMessage(
+    errors.map(error => et(error, t, uischema))
+  );
+};

package/src/i18n/index.ts

@@ -0,0 +1,2 @@
+export * from './i18nTypes';
+export * from './i18nUtil';

package/src/index.ts

@@ -22,40 +22,16 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-export * from './util';
 
-export { JsonSchema } from './models/jsonSchema';
-export { JsonSchema4 } from './models/jsonSchema4';
-export { JsonSchema7 } from './models/jsonSchema7';
-export * from './store';
 export * from './actions';
-import * as Actions from './actions';
-export { Actions };
-export * from './reducers';
+export * as Actions from './actions';
 export * from './generators';
-
-export * from './models/uischema';
-
-import * as Test from './testers';
+export * from './models';
+export * from './reducers';
 export * from './testers';
-export { Test };
-
-import { convertToValidClassName, createLabelDescriptionFrom } from './util';
-import { ControlElement, LabelDescription } from './models/uischema';
-import { JsonSchema } from './models/jsonSchema';
-
-const Helpers: {
-  createLabelDescriptionFrom(
-    withLabel: ControlElement,
-    schema: JsonSchema
-  ): LabelDescription;
-  convertToValidClassName(s: string): string;
-} = {
-  createLabelDescriptionFrom,
-  convertToValidClassName
-};
-
-export { Helpers };
-
+export * as Test from './testers';
 export * from './util';
+
+export * from './Helpers';
 export * from './store';
+export * from './i18n';

package/src/models/draft4.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 export const Draft4 = {
   id: 'http://json-schema.org/draft-04/schema#',
   $schema: 'http://json-schema.org/draft-04/schema#',

package/src/models/index.ts

@@ -0,0 +1,30 @@
+/*
+  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.
+*/
+
+export * from './draft4';
+export * from './jsonSchema';
+export * from './jsonSchema4';
+export * from './jsonSchema7';
+export * from './uischema';

package/src/models/jsonSchema.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { JsonSchema4 } from './jsonSchema4';
 import { JsonSchema7 } from './jsonSchema7';
 

package/src/models/uischema.ts

@@ -22,6 +22,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+
 import { JsonSchema } from './jsonSchema';
 
 /**

package/src/reducers/cells.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_CELL,
@@ -29,7 +30,7 @@ import {
   REMOVE_CELL,
   RemoveCellRendererAction
 } from '../actions';
-import { Reducer } from '../util/type';
+import { Reducer } from '../util';
 
 type ValidCellReducerActions = AddCellRendererAction | RemoveCellRendererAction;