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

package/lib/models/uischema.d.ts

@@ -9,6 +9,14 @@ export interface Scopable {
      */
     scope: string;
 }
+/**
+ * Interface for describing an UI schema element that can provide an internationalization base key.
+ * If defined, this key is suffixed to derive applicable message keys for the UI schema element.
+ * For example, such suffixes are `.label` or `.description` to derive the corresponding message keys for a control element.
+ */
+export interface Internationalizable {
+    i18n?: string;
+}
 /**
  * A rule that may be attached to any UI schema element.
  */
@@ -163,7 +171,7 @@ export interface LabelElement extends UISchemaElement {
  * A control element. The scope property of the control determines
  * to which part of the schema the control should be bound.
  */
-export interface ControlElement extends UISchemaElement, Scopable {
+export interface ControlElement extends UISchemaElement, Scopable, Internationalizable {
     type: 'Control';
     /**
      * An optional label that will be associated with the control
@@ -197,5 +205,6 @@ export interface Categorization extends UISchemaElement {
      */
     elements: (Category | Categorization)[];
 }
+export declare const isInternationalized: (element: unknown) => element is Required<Internationalizable>;
 export declare const isGroup: (layout: Layout) => layout is GroupLayout;
 export declare const isLayout: (uischema: UISchemaElement) => uischema is Layout;

package/lib/reducers/core.d.ts

@@ -9,6 +9,7 @@ export interface JsonFormsCore {
     schema: JsonSchema;
     uischema: UISchemaElement;
     errors?: ErrorObject[];
+    additionalErrors?: ErrorObject[];
     validator?: ValidateFunction;
     ajv?: Ajv;
     validationMode?: ValidationMode;

package/lib/reducers/reducers.d.ts

@@ -17,10 +17,10 @@ export declare const jsonFormsReducerConfig: {
  * @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 fallback the type of the layout to use or a UI-schema-generator function
  * @param control may be checked for embedded inline uischema options
  */
-export declare const findUISchema: (uischemas: JsonFormsUISchemaRegistryEntry[], schema: JsonSchema, schemaPath: string, path: string, fallbackLayoutType?: string, control?: ControlElement, rootSchema?: JsonSchema) => UISchemaElement;
+export declare const findUISchema: (uischemas: JsonFormsUISchemaRegistryEntry[], schema: JsonSchema, schemaPath: string, path: string, fallback?: string | (() => UISchemaElement), control?: ControlElement, rootSchema?: JsonSchema) => UISchemaElement;
 export declare const getErrorAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) => import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
 export declare const getSubErrorsAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsState) => import("ajv").ErrorObject<string, Record<string, any>, unknown>[];
 export declare const getConfig: (state: JsonFormsState) => any;

package/lib/testers/testers.d.ts

@@ -7,12 +7,13 @@ import { Categorization, ControlElement, JsonSchema, UISchemaElement } from '../
 export declare const NOT_APPLICABLE = -1;
 /**
  * A tester is a function that receives an UI schema and a JSON schema and returns a boolean.
+ * The rootSchema is handed over as context. Can be used to resolve references.
  */
-export declare type Tester = (uischema: UISchemaElement, schema: JsonSchema) => boolean;
+export declare type Tester = (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => boolean;
 /**
  * A ranked tester associates a tester with a number.
  */
-export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema) => number;
+export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => number;
 export declare const isControl: (uischema: any) => uischema is ControlElement;
 /**
  * Only applicable for Controls.
@@ -24,8 +25,8 @@ export declare const isControl: (uischema: any) => uischema is ControlElement;
  * @param {(JsonSchema) => boolean} predicate the predicate that should be
  *        applied to the resolved sub-schema
  */
-export declare const schemaMatches: (predicate: (schema: JsonSchema) => boolean) => Tester;
-export declare const schemaSubPathMatches: (subPath: string, predicate: (schema: JsonSchema) => boolean) => Tester;
+export declare const schemaMatches: (predicate: (schema: JsonSchema, rootSchema: JsonSchema) => boolean) => Tester;
+export declare const schemaSubPathMatches: (subPath: string, predicate: (schema: JsonSchema, rootSchema: JsonSchema) => boolean) => Tester;
 /**
  * Only applicable for Controls.
  *
@@ -96,8 +97,8 @@ export declare const or: (...testers: Tester[]) => Tester;
  * @param {number} rank the rank to be returned in case the tester returns true
  * @param {Tester} tester a tester
  */
-export declare const rankWith: (rank: number, tester: Tester) => (uischema: UISchemaElement, schema: JsonSchema) => number;
-export declare const withIncreasedRank: (by: number, rankedTester: RankedTester) => (uischema: UISchemaElement, schema: JsonSchema) => number;
+export declare const rankWith: (rank: number, tester: Tester) => (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => number;
+export declare const withIncreasedRank: (by: number, rankedTester: RankedTester) => (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => number;
 /**
  * Default tester for boolean.
  * @type {RankedTester}
@@ -172,7 +173,7 @@ export declare const isObjectArray: Tester;
  * @type {Tester}
  */
 export declare const isObjectArrayControl: Tester;
-export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema) => boolean;
+export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => boolean;
 /**
  * Synonym for isObjectArrayControl
  */

package/lib/util/combinators.d.ts

@@ -6,5 +6,4 @@ export interface CombinatorSubSchemaRenderInfo {
     label: string;
 }
 export declare type CombinatorKeyword = 'anyOf' | 'oneOf' | 'allOf';
-export declare const resolveSubSchemas: (schema: JsonSchema, rootSchema: JsonSchema, keyword: CombinatorKeyword) => JsonSchema;
 export declare const createCombinatorRenderInfos: (combinatorSubSchemas: JsonSchema[], rootSchema: JsonSchema, keyword: CombinatorKeyword, control: ControlElement, path: string, uischemas: JsonFormsUISchemaRegistryEntry[]) => CombinatorSubSchemaRenderInfo[];

package/lib/util/path.d.ts

@@ -23,3 +23,13 @@ export declare const toDataPathSegments: (schemaPath: string) => string[];
  */
 export declare const toDataPath: (schemaPath: string) => string;
 export declare const composeWithUi: (scopableUi: Scopable, path: string) => string;
+/**
+ * Encodes the given segment to be used as part of a JSON Pointer
+ *
+ * JSON Pointer has special meaning for "/" and "~", therefore these must be encoded
+ */
+export declare const encode: (segment: string) => string;
+/**
+ * Decodes a given JSON Pointer segment to its "normal" representation
+ */
+export declare const decode: (pointerSegment: string) => string;

package/lib/util/renderer.d.ts

@@ -1,5 +1,5 @@
 import { ControlElement, JsonSchema, UISchemaElement } from '../models';
-import type { JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry } from '../reducers';
+import { JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry } from '../reducers';
 import { JsonFormsUISchemaRegistryEntry } from '../reducers';
 import { RankedTester } from '../testers';
 import { CombinatorKeyword } from './combinators';
@@ -359,7 +359,7 @@ export declare const controlDefaultProps: {
     path: string;
     direction: 'row' | 'column';
 };
-export interface StatePropsOfCombinator extends OwnPropsOfControl {
+export interface StatePropsOfCombinator extends StatePropsOfControl {
     rootSchema: JsonSchema;
     path: string;
     id: string;

package/lib/util/resolvers.d.ts

@@ -22,4 +22,4 @@ export declare const findAllRefs: (schema: JsonSchema, result?: ReferenceSchemaM
  * @param {JsonSchema} rootSchema the actual root schema
  * @returns {JsonSchema} the resolved sub-schema
  */
-export declare const resolveSchema: (schema: JsonSchema, schemaPath: string, rootSchema?: JsonSchema) => JsonSchema;
+export declare const resolveSchema: (schema: JsonSchema, schemaPath: string, rootSchema: JsonSchema) => JsonSchema;

package/lib/util/util.d.ts

@@ -18,7 +18,7 @@ export declare const deriveTypes: (jsonSchema: JsonSchema) => string[];
 * Convenience wrapper around resolveData and resolveSchema.
 */
 export declare const Resolve: {
-    schema(schema: JsonSchema, schemaPath: string, rootSchema?: JsonSchema): JsonSchema;
+    schema(schema: JsonSchema, schemaPath: string, rootSchema: JsonSchema): JsonSchema;
     data(data: any, path: string): any;
 };
 export declare const Paths: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.4",
   "description": "Core module of JSON Forms",
   "repository": "https://github.com/eclipsesource/jsonforms",
   "bugs": "https://github.com/eclipsesource/jsonforms/issues",
@@ -88,5 +88,5 @@
     "typedoc": "^0.19.2",
     "typescript": "4.2.3"
   },
-  "gitHead": "8c3b6263f360ca192c0a20a343a19c5ffb3a10f7"
+  "gitHead": "413b9767ea8e2c0b6adb3919f5e6b76263d4be31"
 }

package/src/actions/actions.ts

@@ -100,6 +100,7 @@ export interface UpdateCoreAction {
 export interface InitActionOptions {
   ajv?: AJV;
   validationMode?: ValidationMode;
+  additionalErrors?: ErrorObject[];
 }
 
 export interface SetValidationModeAction {

package/src/generators/uischema.ts

@@ -35,7 +35,7 @@ import {
   Layout,
   UISchemaElement
 } from '../models';
-import { deriveTypes, resolveSchema } from '../util';
+import { deriveTypes, encode, resolveSchema } from '../util';
 
 /**
  * Creates a new ILayout.
@@ -122,7 +122,7 @@ const generateUISchema = (
 ): UISchemaElement => {
   if (!isEmpty(jsonSchema) && jsonSchema.$ref !== undefined) {
     return generateUISchema(
-      resolveSchema(rootSchema, jsonSchema.$ref),
+      resolveSchema(rootSchema, jsonSchema.$ref, rootSchema),
       schemaElements,
       currentRef,
       schemaName,
@@ -162,9 +162,9 @@ const generateUISchema = (
       const nextRef: string = currentRef + '/properties';
       Object.keys(jsonSchema.properties).map(propName => {
         let value = jsonSchema.properties[propName];
-        const ref = `${nextRef}/${propName}`;
+        const ref = `${nextRef}/${encode(propName)}`;
         if (value.$ref !== undefined) {
-          value = resolveSchema(rootSchema, value.$ref);
+          value = resolveSchema(rootSchema, value.$ref, rootSchema);
         }
         generateUISchema(
           value,

package/src/i18n/i18nUtil.ts

@@ -1,5 +1,5 @@
 import { ErrorObject } from 'ajv';
-import { UISchemaElement } from '../models';
+import { isInternationalized, UISchemaElement } from '../models';
 import { getControlPath } from '../reducers';
 import { formatErrorMessage } from '../util';
 import { i18nJsonSchema, ErrorTranslator, Translator } from './i18nTypes';
@@ -8,7 +8,10 @@ export const getI18nKeyPrefixBySchema = (
   schema: i18nJsonSchema | undefined,
   uischema: UISchemaElement | undefined
 ): string | undefined => {
-  return uischema?.options?.i18n ?? schema?.i18n ?? undefined;
+  if (isInternationalized(uischema)) {
+    return uischema.i18n;
+  }
+  return schema?.i18n ?? undefined;
 };
 
 /**
@@ -54,26 +57,26 @@ export const defaultErrorTranslator: ErrorTranslator = (error, t, uischema) => {
     getControlPath(error),
     `error.${error.keyword}`
   );
-  const specializedKeywordMessage = t(i18nKey, undefined);
+  const specializedKeywordMessage = t(i18nKey, undefined, { error } );
   if (specializedKeywordMessage !== undefined) {
     return specializedKeywordMessage;
   }
 
   // check whether there is a generic keyword message
-  const genericKeywordMessage = t(`error.${error.keyword}`, undefined);
+  const genericKeywordMessage = t(`error.${error.keyword}`, undefined, { error });
   if (genericKeywordMessage !== undefined) {
     return genericKeywordMessage;
   }
 
   // check whether there is a customization for the default message
-  const messageCustomization = t(error.message, undefined);
+  const messageCustomization = t(error.message, undefined, { error });
   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 t('is a required property', 'is a required property', { error });
   }
 
   return error.message;
@@ -94,7 +97,7 @@ export const getCombinedErrorMessage = (
   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);
+    const specializedErrorMessage = t(customErrorKey, undefined, {schema, uischema, path, errors});
     if (specializedErrorMessage !== undefined) {
       return specializedErrorMessage;
     }

package/src/models/uischema.ts

@@ -36,6 +36,15 @@ export interface Scopable {
   scope: string;
 }
 
+/**
+ * Interface for describing an UI schema element that can provide an internationalization base key.
+ * If defined, this key is suffixed to derive applicable message keys for the UI schema element.
+ * For example, such suffixes are `.label` or `.description` to derive the corresponding message keys for a control element.
+ */
+export interface Internationalizable {
+  i18n?: string;
+}
+
 /**
  * A rule that may be attached to any UI schema element.
  */
@@ -207,7 +216,7 @@ export interface LabelElement extends UISchemaElement {
  * A control element. The scope property of the control determines
  * to which part of the schema the control should be bound.
  */
-export interface ControlElement extends UISchemaElement, Scopable {
+export interface ControlElement extends UISchemaElement, Scopable, Internationalizable {
   type: 'Control';
   /**
    * An optional label that will be associated with the control
@@ -244,6 +253,10 @@ export interface Categorization extends UISchemaElement {
   elements: (Category | Categorization)[];
 }
 
+export const isInternationalized = (element: unknown): element is Required<Internationalizable> => {
+  return typeof element === 'object' && element !== null && typeof (element as Internationalizable).i18n === 'string';
+}
+
 export const isGroup = (layout: Layout): layout is GroupLayout =>
   layout.type === 'Group';
 

package/src/reducers/core.ts

@@ -65,6 +65,7 @@ export interface JsonFormsCore {
   schema: JsonSchema;
   uischema: UISchemaElement;
   errors?: ErrorObject[];
+  additionalErrors?: ErrorObject[];
   validator?: ValidateFunction;
   ajv?: Ajv;
   validationMode?: ValidationMode;
@@ -78,6 +79,7 @@ const initState: JsonFormsCore = {
   validator: undefined,
   ajv: undefined,
   validationMode: 'ValidateAndShow',
+  additionalErrors: []
 };
 
 const reuseAjvForSchema = (ajv: Ajv, schema: JsonSchema): Ajv => {
@@ -133,6 +135,23 @@ const hasValidationModeOption = (option: any): option is InitActionOptions => {
   return false;
 };
 
+const hasAdditionalErrorsOption = (option: any): option is InitActionOptions => {
+  if (option) {
+    return option.additionalErrors !== undefined;
+  }
+  return false;
+};
+
+const getAdditionalErrors = (
+  state: JsonFormsCore,
+  action?: InitAction | UpdateCoreAction
+): ErrorObject[] => {
+  if (action && hasAdditionalErrorsOption(action.options)) {
+    return action.options.additionalErrors;
+  }
+  return state.additionalErrors;
+};
+
 // tslint:disable-next-line: cyclomatic-complexity
 export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
   state = initState,
@@ -145,12 +164,14 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       const validationMode = getValidationMode(state, action);
       const v = validationMode === 'NoValidation' ? undefined : thisAjv.compile(action.schema);
       const e = validate(v, action.data);
+      const additionalErrors = getAdditionalErrors(state, action);
 
       return {
         ...state,
         data: action.data,
         schema: action.schema,
         uischema: action.uischema,
+        additionalErrors,
         errors: e,
         validator: v,
         ajv: thisAjv,
@@ -176,6 +197,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
       } else if (state.data !== action.data) {
         errors = validate(validator, action.data);
       }
+      const additionalErrors = getAdditionalErrors(state, action);
 
       const stateChanged =
         state.data !== action.data ||
@@ -184,7 +206,8 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
         state.ajv !== thisAjv ||
         state.errors !== errors ||
         state.validator !== validator ||
-        state.validationMode !== validationMode
+        state.validationMode !== validationMode ||
+        state.additionalErrors !== additionalErrors
       return stateChanged
         ? {
             ...state,
@@ -195,6 +218,7 @@ export const coreReducer: Reducer<JsonFormsCore, CoreActions> = (
             errors: isEqual(errors, state.errors) ? state.errors : errors,
             validator: validator,
             validationMode: validationMode,
+            additionalErrors
           }
         : state;
     }
@@ -391,8 +415,11 @@ const getErrorsAt = (
   instancePath: string,
   schema: JsonSchema,
   matchPath: (path: string) => boolean
-) => (state: JsonFormsCore): ErrorObject[] =>
-  errorsAt(instancePath, schema, matchPath)(state.validationMode === 'ValidateAndHide' ? [] : state.errors);
+) => (state: JsonFormsCore): ErrorObject[] => {
+  const errors = state.errors ?? [];
+  const additionalErrors = state.additionalErrors ?? [];
+  return errorsAt(instancePath, schema, matchPath)(state.validationMode === 'ValidateAndHide' ? additionalErrors : [...errors, ...additionalErrors]);
+}
 
 export const errorAt = (instancePath: string, schema: JsonSchema) =>
   getErrorsAt(instancePath, schema, path => path === instancePath);

package/src/reducers/reducers.ts

@@ -67,7 +67,7 @@ export const jsonFormsReducerConfig = {
  * @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 fallback the type of the layout to use or a UI-schema-generator function
  * @param control may be checked for embedded inline uischema options
  */
 export const findUISchema = (
@@ -75,7 +75,7 @@ export const findUISchema = (
   schema: JsonSchema,
   schemaPath: string,
   path: string,
-  fallbackLayoutType = 'VerticalLayout',
+  fallback: string | (() => UISchemaElement) = 'VerticalLayout',
   control?: ControlElement,
   rootSchema?: JsonSchema
 ): UISchemaElement => {
@@ -83,8 +83,12 @@ export const findUISchema = (
   if (control && control.options && control.options.detail) {
     if (typeof control.options.detail === 'string') {
       if (control.options.detail.toUpperCase() === 'GENERATE') {
+        //use fallback generation function
+        if(typeof fallback === "function"){
+          return fallback();
+        }
         // force generation of uischema
-        return Generate.uiSchema(schema, fallbackLayoutType);
+        return Generate.uiSchema(schema, fallback);
       }
     } else if (typeof control.options.detail === 'object') {
       // check if detail is a valid uischema
@@ -99,7 +103,11 @@ export const findUISchema = (
   // default
   const uiSchema = findMatchingUISchema(uischemas)(schema, schemaPath, path);
   if (uiSchema === undefined) {
-    return Generate.uiSchema(schema, fallbackLayoutType, '#', rootSchema);
+    //use fallback generation function
+    if(typeof fallback === 'function'){
+      return fallback();
+    }
+    return Generate.uiSchema(schema, fallback, '#', rootSchema);
   }
   return uiSchema;
 };