@jsonforms/core 3.0.0-beta.3 → 3.0.0-rc.0

package/lib/models/uischema.d.ts

@@ -1,14 +1,42 @@
 import { JsonSchema } from './jsonSchema';
 /**
  * Interface for describing an UI schema element that is referencing
- * a subschema. The value of the scope must be a JSON Pointer.
+ * a subschema. The value of the scope may be a JSON Pointer.
  */
 export interface Scopable {
+    /**
+     * The scope that determines to which part this element should be bound to.
+     */
+    scope?: string;
+}
+/**
+ * Interface for describing an UI schema element that is referencing
+ * a subschema. The value of the scope must be a JSON Pointer.
+ */
+export interface Scoped extends Scopable {
     /**
      * The scope that determines to which part this element should be bound to.
      */
     scope: string;
 }
+/**
+ * Interface for describing an UI schema element that may be labeled.
+ */
+export interface Labelable<T = string> {
+    /**
+     * Label for UI schema element.
+     */
+    label?: string | T;
+}
+/**
+ * Interface for describing an UI schema element that is labeled.
+ */
+export interface Labeled<T = string> extends Labelable<T> {
+    label: string | T;
+}
+export interface Internationalizable {
+    i18n?: string;
+}
 /**
  * A rule that may be attached to any UI schema element.
  */
@@ -56,14 +84,14 @@ export interface Condition {
 /**
  * A leaf condition.
  */
-export interface LeafCondition extends Condition, Scopable {
+export interface LeafCondition extends Condition, Scoped {
     type: 'LEAF';
     /**
      * The expected value when evaluating the condition
      */
     expectedValue: any;
 }
-export interface SchemaBasedCondition extends Condition, Scopable {
+export interface SchemaBasedCondition extends Condition, Scoped {
     schema: JsonSchema;
 }
 /**
@@ -129,12 +157,8 @@ export interface HorizontalLayout extends Layout {
  * A group resembles a vertical layout, but additionally might have a label.
  * This layout is useful when grouping different elements by a certain criteria.
  */
-export interface GroupLayout extends Layout {
+export interface GroupLayout extends Layout, Labelable {
     type: 'Group';
-    /**
-     * The label of this group layout.
-     */
-    label?: string;
 }
 /**
  * Represents an object that can be used to configure a label.
@@ -152,7 +176,7 @@ export interface LabelDescription {
 /**
  * A label element.
  */
-export interface LabelElement extends UISchemaElement {
+export interface LabelElement extends UISchemaElement, Internationalizable {
     type: 'Label';
     /**
      * The text of label.
@@ -163,39 +187,32 @@ 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, Scoped, Labelable<string | boolean | LabelDescription>, Internationalizable {
     type: 'Control';
-    /**
-     * An optional label that will be associated with the control
-     */
-    label?: string | boolean | LabelDescription;
 }
 /**
  * The category layout.
  */
-export interface Category extends Layout {
+export interface Category extends Layout, Labeled {
     type: 'Category';
-    /**
-     * The label associated with this category layout.
-     */
-    label: string;
 }
 /**
  * The categorization element, which may have children elements.
  * A child element may either be itself a Categorization or a Category, hence
  * the categorization element can be used to represent recursive structures like trees.
  */
-export interface Categorization extends UISchemaElement {
+export interface Categorization extends UISchemaElement, Labeled {
     type: 'Categorization';
-    /**
-     * The label of this categorization.
-     */
-    label: string;
     /**
      * The child elements of this categorization which are either of type
      * {@link Category} or {@link Categorization}.
      */
     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;
+export declare const isScopable: (obj: unknown) => obj is Scopable;
+export declare const isScoped: (obj: unknown) => obj is Scoped;
+export declare const isLabelable: (obj: unknown) => obj is Labelable<string>;
+export declare const isLabeled: <T = never>(obj: unknown) => obj is Labeled<T>;

package/lib/reducers/i18n.d.ts

@@ -1,7 +1,7 @@
 import { JsonFormsI18nState } from '../i18n';
 import { I18nActions } from '../actions';
 import { Reducer } from '../util';
-export declare const defaultJsonFormsI18nState: JsonFormsI18nState;
+export declare const defaultJsonFormsI18nState: Required<JsonFormsI18nState>;
 export declare const i18nReducer: Reducer<JsonFormsI18nState, I18nActions>;
 export declare const fetchLocale: (state?: JsonFormsI18nState) => string;
 export declare const fetchTranslator: (state?: JsonFormsI18nState) => import("../i18n").Translator;

package/lib/testers/testers.d.ts

@@ -9,11 +9,20 @@ 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, rootSchema: JsonSchema) => boolean;
+export declare type Tester = (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => boolean;
 /**
  * A ranked tester associates a tester with a number.
  */
-export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => number;
+export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => number;
+/**
+ * Additional context given to a tester in addition to UISchema and JsonSchema.
+ */
+export interface TesterContext {
+    /** The root JsonSchema of the form. Can be used to resolve references. */
+    rootSchema: JsonSchema;
+    /** The form wide configuration object given to JsonForms. */
+    config: any;
+}
 export declare const isControl: (uischema: any) => uischema is ControlElement;
 /**
  * Only applicable for Controls.
@@ -97,8 +106,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, rootSchema: JsonSchema) => number;
-export declare const withIncreasedRank: (by: number, rankedTester: RankedTester) => (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => number;
+export declare const rankWith: (rank: number, tester: Tester) => (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => number;
+export declare const withIncreasedRank: (by: number, rankedTester: RankedTester) => (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => number;
 /**
  * Default tester for boolean.
  * @type {RankedTester}
@@ -173,7 +182,7 @@ export declare const isObjectArray: Tester;
  * @type {Tester}
  */
 export declare const isObjectArrayControl: Tester;
-export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema, rootSchema: JsonSchema) => boolean;
+export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => boolean;
 /**
  * Synonym for isObjectArrayControl
  */
@@ -193,7 +202,7 @@ export declare const isPrimitiveArrayControl: Tester;
 export declare const isRangeControl: Tester;
 /**
  * Tests whether the given UI schema is of type Control, if the schema
- * is of type string and has option format
+ * is of type integer and has option format
  * @type {Tester}
  */
 export declare const isNumberFormatControl: Tester;

package/lib/util/renderer.d.ts

@@ -1,4 +1,4 @@
-import { ControlElement, JsonSchema, UISchemaElement } from '../models';
+import { ControlElement, JsonSchema, LabelElement, UISchemaElement } from '../models';
 import { JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry } from '../reducers';
 import { JsonFormsUISchemaRegistryEntry } from '../reducers';
 import { RankedTester } from '../testers';
@@ -82,6 +82,9 @@ export interface OwnPropsOfControl extends OwnPropsOfRenderer {
     id?: string;
     uischema?: ControlElement;
 }
+export interface OwnPropsOfLabel extends OwnPropsOfRenderer {
+    uischema?: LabelElement;
+}
 export interface OwnPropsOfEnum {
     options?: EnumOption[];
 }
@@ -202,6 +205,7 @@ export interface StatePropsOfLayout extends StatePropsOfRenderer {
      * Direction for the layout to flow
      */
     direction: 'row' | 'column';
+    label?: string;
 }
 export interface LayoutProps extends StatePropsOfLayout {
 }
@@ -348,6 +352,7 @@ export interface OwnPropsOfJsonFormsRenderer extends OwnPropsOfRenderer {
 }
 export interface StatePropsOfJsonFormsRenderer extends OwnPropsOfJsonFormsRenderer {
     rootSchema: JsonSchema;
+    config: any;
 }
 export interface JsonFormsProps extends StatePropsOfJsonFormsRenderer {
 }
@@ -396,3 +401,15 @@ export declare const mapStateToArrayLayoutProps: (state: JsonFormsState, ownProp
  */
 export interface ArrayLayoutProps extends StatePropsOfArrayLayout, DispatchPropsOfArrayControl {
 }
+export interface StatePropsOfLabel extends StatePropsOfRenderer {
+    text?: string;
+}
+export interface LabelProps extends StatePropsOfLabel {
+}
+export declare const mapStateToLabelProps: (state: JsonFormsState, props: OwnPropsOfLabel) => {
+    text: string;
+    visible: boolean;
+    config: any;
+    renderers: JsonFormsRendererRegistryEntry[];
+    cells: JsonFormsCellRendererRegistryEntry[];
+};

package/lib/util/runtime.d.ts

@@ -1,7 +1,6 @@
-import { UISchemaElement } from '../models';
+import { JsonSchema, UISchemaElement } from '../models';
 import Ajv from 'ajv';
 import { JsonFormsState } from '../store';
-import { JsonSchema } from '../models/jsonSchema';
 export declare const evalVisibility: (uischema: UISchemaElement, data: any, path: string, ajv: Ajv) => boolean;
 export declare const evalEnablement: (uischema: UISchemaElement, data: any, path: string, ajv: Ajv) => boolean;
 export declare const hasShowRule: (uischema: UISchemaElement) => boolean;

package/lib/util/util.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchema, Scopable, UISchemaElement } from '..';
+import { JsonSchema, Scoped, UISchemaElement } from '..';
 import Ajv from 'ajv';
 /**
  * Escape the given string such that it can be used as a class name,
@@ -11,19 +11,19 @@ export declare const convertToValidClassName: (s: string) => string;
 export declare const formatErrorMessage: (errors: string[]) => string;
 export declare const hasType: (jsonSchema: JsonSchema, expected: string) => boolean;
 /**
-* Derives the type of the jsonSchema element
-*/
+ * Derives the type of the jsonSchema element
+ */
 export declare const deriveTypes: (jsonSchema: JsonSchema) => string[];
 /**
-* Convenience wrapper around resolveData and resolveSchema.
-*/
+ * Convenience wrapper around resolveData and resolveSchema.
+ */
 export declare const Resolve: {
     schema(schema: JsonSchema, schemaPath: string, rootSchema: JsonSchema): JsonSchema;
     data(data: any, path: string): any;
 };
 export declare const Paths: {
     compose: (path1: string, path2: string) => string;
-    fromScopable: (scopable: Scopable) => string;
+    fromScoped: (scopable: Scoped) => string;
 };
 export declare const Runtime: {
     isEnabled(uischema: UISchemaElement, data: any, ajv: Ajv): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-rc.0",
   "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": "78ef46d070f9c5ac1db1f04772db1293858ce2a4"
+  "gitHead": "5ef030e8b3f91bcdc3e6b8d232a0b191bf1195ce"
 }

package/src/i18n/i18nUtil.ts

@@ -1,21 +1,24 @@
 import { ErrorObject } from 'ajv';
-import { UISchemaElement } from '../models';
+import { isInternationalized, Labelable, 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
+  uischema: unknown | undefined
 ): string | undefined => {
-  return uischema?.options?.i18n ?? schema?.i18n ?? undefined;
+  if (isInternationalized(uischema)) {
+    return uischema.i18n;
+  }
+  return 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) => {
+export const transformPathToI18nPrefix = (path: string): string => {
   return (
     path
       ?.split('.')
@@ -26,9 +29,9 @@ export const transformPathToI18nPrefix = (path: string) => {
 
 export const getI18nKeyPrefix = (
   schema: i18nJsonSchema | undefined,
-  uischema: UISchemaElement | undefined,
+  uischema: unknown | undefined,
   path: string | undefined
-): string | undefined => {
+): string => {
   return (
     getI18nKeyPrefixBySchema(schema, uischema) ??
     transformPathToI18nPrefix(path)
@@ -37,10 +40,10 @@ export const getI18nKeyPrefix = (
 
 export const getI18nKey = (
   schema: i18nJsonSchema | undefined,
-  uischema: UISchemaElement | undefined,
+  uischema: unknown | undefined,
   path: string | undefined,
   key: string
-): string | undefined => {
+): string => {
   return `${getI18nKeyPrefix(schema, uischema, path)}.${key}`;
 };
 
@@ -103,3 +106,20 @@ export const getCombinedErrorMessage = (
     errors.map(error => et(error, t, uischema))
   );
 };
+
+/**
+ * This can be used to internationalize the label of the given Labelable (e.g. UI Schema elements).
+ * This should not be used for controls as there we have additional context in the form of the JSON Schema available.
+ */
+export const deriveLabelForUISchemaElement = (uischema: Labelable<boolean>, t: Translator): string | undefined => {
+  if (uischema.label === false) {
+    return undefined;
+  }
+  if ((uischema.label === undefined || uischema.label === null || uischema.label === true) && !isInternationalized(uischema)) {
+    return undefined;
+  }
+  const stringifiedLabel = typeof uischema.label === 'string' ? uischema.label : JSON.stringify(uischema.label);
+  const i18nKeyPrefix = getI18nKeyPrefixBySchema(undefined, uischema);
+  const i18nKey = typeof i18nKeyPrefix === 'string' ? `${i18nKeyPrefix}.label` : stringifiedLabel;
+  return t(i18nKey, stringifiedLabel, { uischema: uischema });
+}

package/src/models/uischema.ts

@@ -27,15 +27,52 @@ import { JsonSchema } from './jsonSchema';
 
 /**
  * Interface for describing an UI schema element that is referencing
- * a subschema. The value of the scope must be a JSON Pointer.
+ * a subschema. The value of the scope may be a JSON Pointer.
  */
 export interface Scopable {
+  /**
+   * The scope that determines to which part this element should be bound to.
+   */
+  scope?: string;
+}
+
+/**
+ * Interface for describing an UI schema element that is referencing
+ * a subschema. The value of the scope must be a JSON Pointer.
+ */
+export interface Scoped extends Scopable {
   /**
    * The scope that determines to which part this element should be bound to.
    */
   scope: string;
 }
 
+/**
+ * Interface for describing an UI schema element that may be labeled.
+ */
+export interface Labelable<T = string> {
+  /**
+   * Label for UI schema element.
+   */
+  label?: string|T;
+}
+
+/**
+ * Interface for describing an UI schema element that is labeled.
+ */
+export interface Labeled<T = string> extends Labelable<T> {
+  label: string | T;
+}
+
+/*
+ * 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.
  */
@@ -87,7 +124,7 @@ export interface Condition {
 /**
  * A leaf condition.
  */
-export interface LeafCondition extends Condition, Scopable {
+export interface LeafCondition extends Condition, Scoped {
   type: 'LEAF';
 
   /**
@@ -96,7 +133,7 @@ export interface LeafCondition extends Condition, Scopable {
   expectedValue: any;
 }
 
-export interface SchemaBasedCondition extends Condition, Scopable {
+export interface SchemaBasedCondition extends Condition, Scoped {
   schema: JsonSchema;
 }
 
@@ -170,12 +207,8 @@ export interface HorizontalLayout extends Layout {
  * A group resembles a vertical layout, but additionally might have a label.
  * This layout is useful when grouping different elements by a certain criteria.
  */
-export interface GroupLayout extends Layout {
+export interface GroupLayout extends Layout, Labelable {
   type: 'Group';
-  /**
-   * The label of this group layout.
-   */
-  label?: string;
 }
 
 /**
@@ -195,7 +228,7 @@ export interface LabelDescription {
 /**
  * A label element.
  */
-export interface LabelElement extends UISchemaElement {
+export interface LabelElement extends UISchemaElement, Internationalizable {
   type: 'Label';
   /**
    * The text of label.
@@ -207,23 +240,15 @@ 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, Scoped, Labelable<string | boolean | LabelDescription>, Internationalizable {
   type: 'Control';
-  /**
-   * An optional label that will be associated with the control
-   */
-  label?: string | boolean | LabelDescription;
 }
 
 /**
  * The category layout.
  */
-export interface Category extends Layout {
+export interface Category extends Layout, Labeled {
   type: 'Category';
-  /**
-   * The label associated with this category layout.
-   */
-  label: string;
 }
 
 /**
@@ -231,12 +256,8 @@ export interface Category extends Layout {
  * A child element may either be itself a Categorization or a Category, hence
  * the categorization element can be used to represent recursive structures like trees.
  */
-export interface Categorization extends UISchemaElement {
+export interface Categorization extends UISchemaElement, Labeled {
   type: 'Categorization';
-  /**
-   * The label of this categorization.
-   */
-  label: string;
   /**
    * The child elements of this categorization which are either of type
    * {@link Category} or {@link Categorization}.
@@ -244,8 +265,23 @@ export interface Categorization extends UISchemaElement {
   elements: (Category | Categorization)[];
 }
 
+export const isInternationalized = (element: unknown): element is Required<Internationalizable> =>
+  typeof element === 'object' && element !== null && typeof (element as Internationalizable).i18n === 'string';
+
 export const isGroup = (layout: Layout): layout is GroupLayout =>
   layout.type === 'Group';
 
 export const isLayout = (uischema: UISchemaElement): uischema is Layout =>
   (uischema as Layout).elements !== undefined;
+
+export const isScopable = (obj: unknown): obj is Scopable =>
+  obj && typeof obj === 'object';
+
+export const isScoped = (obj: unknown): obj is Scoped =>
+  isScopable(obj) && typeof obj.scope === 'string';
+
+export const isLabelable = (obj: unknown): obj is Labelable =>
+  obj && typeof obj === 'object';
+
+export const isLabeled = <T = never>(obj: unknown): obj is Labeled<T> =>
+  isLabelable(obj) && ['string', 'boolean'].includes(typeof obj.label);

package/src/reducers/i18n.ts

@@ -27,7 +27,7 @@ import { defaultErrorTranslator, defaultTranslator, JsonFormsI18nState } from '.
 import { I18nActions, SET_LOCALE, SET_TRANSLATOR, UPDATE_I18N } from '../actions';
 import { Reducer } from '../util';
 
-export const defaultJsonFormsI18nState: JsonFormsI18nState = {
+export const defaultJsonFormsI18nState: Required<JsonFormsI18nState> = {
   locale: 'en',
   translate: defaultTranslator,
   translateError: defaultErrorTranslator