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

package/lib/actions/actions.d.ts

@@ -1,177 +1,181 @@
-import AJV, { ErrorObject } from 'ajv';
-import { JsonSchema, UISchemaElement } from '../models';
-import { RankedTester } from '../testers';
-import { UISchemaTester, ValidationMode } from '../reducers';
-export declare const INIT: 'jsonforms/INIT';
-export declare const UPDATE_CORE: 'jsonforms/UPDATE_CORE';
-export declare const SET_AJV: 'jsonforms/SET_AJV';
-export declare const UPDATE_DATA: 'jsonforms/UPDATE';
-export declare const UPDATE_ERRORS: 'jsonforms/UPDATE_ERRORS';
-export declare const VALIDATE: 'jsonforms/VALIDATE';
-export declare const ADD_RENDERER: 'jsonforms/ADD_RENDERER';
-export declare const REMOVE_RENDERER: 'jsonforms/REMOVE_RENDERER';
-export declare const ADD_CELL: 'jsonforms/ADD_CELL';
-export declare const REMOVE_CELL: 'jsonforms/REMOVE_CELL';
-export declare const SET_CONFIG: 'jsonforms/SET_CONFIG';
-export declare const ADD_UI_SCHEMA: 'jsonforms/ADD_UI_SCHEMA';
-export declare const REMOVE_UI_SCHEMA: 'jsonforms/REMOVE_UI_SCHEMA';
-export declare const SET_SCHEMA: 'jsonforms/SET_SCHEMA';
-export declare const SET_UISCHEMA: 'jsonforms/SET_UISCHEMA';
-export declare const SET_VALIDATION_MODE: 'jsonforms/SET_VALIDATION_MODE';
-export declare const SET_LOCALE: 'jsonforms/SET_LOCALE';
-export declare const SET_LOCALIZED_SCHEMAS: 'jsonforms/SET_LOCALIZED_SCHEMAS';
-export declare const SET_LOCALIZED_UISCHEMAS: 'jsonforms/SET_LOCALIZED_UISCHEMAS';
-export declare const ADD_DEFAULT_DATA: 'jsonforms/ADD_DEFAULT_DATA';
-export declare const REMOVE_DEFAULT_DATA: 'jsonforms/REMOVE_DEFAULT_DATA';
-export declare 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;
-    validationMode?: ValidationMode;
-}
-export interface SetValidationModeAction {
-    type: 'jsonforms/SET_VALIDATION_MODE';
-    validationMode: ValidationMode;
-}
-export declare const init: (data: any, schema?: JsonSchema, uischema?: UISchemaElement, options?: InitActionOptions | AJV.Ajv) => {
-    type: "jsonforms/INIT";
-    data: any;
-    schema: JsonSchema;
-    uischema: UISchemaElement;
-    options: InitActionOptions | AJV.Ajv;
-};
-export declare const updateCore: (data: any, schema: JsonSchema, uischema?: UISchemaElement, options?: InitActionOptions | AJV.Ajv) => UpdateCoreAction;
-export interface RegisterDefaultDataAction {
-    type: 'jsonforms/ADD_DEFAULT_DATA';
-    schemaPath: string;
-    data: any;
-}
-export declare const registerDefaultData: (schemaPath: string, data: any) => {
-    type: "jsonforms/ADD_DEFAULT_DATA";
-    schemaPath: string;
-    data: any;
-};
-export interface UnregisterDefaultDataAction {
-    type: 'jsonforms/REMOVE_DEFAULT_DATA';
-    schemaPath: string;
-}
-export declare const unregisterDefaultData: (schemaPath: string) => {
-    type: "jsonforms/REMOVE_DEFAULT_DATA";
-    schemaPath: string;
-};
-export interface SetAjvAction {
-    type: 'jsonforms/SET_AJV';
-    ajv: AJV.Ajv;
-}
-export declare const setAjv: (ajv: AJV.Ajv) => {
-    type: "jsonforms/SET_AJV";
-    ajv: AJV.Ajv;
-};
-export declare const update: (path: string, updater: (existingData: any) => any) => UpdateAction;
-export declare const updateErrors: (errors: AJV.ErrorObject[]) => UpdateErrorsAction;
-export interface AddRendererAction {
-    type: 'jsonforms/ADD_RENDERER';
-    tester: RankedTester;
-    renderer: any;
-}
-export declare const registerRenderer: (tester: RankedTester, renderer: any) => {
-    type: "jsonforms/ADD_RENDERER";
-    tester: RankedTester;
-    renderer: any;
-};
-export interface AddCellRendererAction {
-    type: 'jsonforms/ADD_CELL';
-    tester: RankedTester;
-    cell: any;
-}
-export declare const registerCell: (tester: RankedTester, cell: any) => {
-    type: "jsonforms/ADD_CELL";
-    tester: RankedTester;
-    cell: any;
-};
-export interface RemoveCellRendererAction {
-    type: 'jsonforms/REMOVE_CELL';
-    tester: RankedTester;
-    cell: any;
-}
-export declare const unregisterCell: (tester: RankedTester, cell: any) => {
-    type: "jsonforms/REMOVE_CELL";
-    tester: RankedTester;
-    cell: any;
-};
-export interface RemoveRendererAction {
-    type: 'jsonforms/REMOVE_RENDERER';
-    tester: RankedTester;
-    renderer: any;
-}
-export declare const unregisterRenderer: (tester: RankedTester, renderer: any) => {
-    type: "jsonforms/REMOVE_RENDERER";
-    tester: RankedTester;
-    renderer: any;
-};
-export interface SetConfigAction {
-    type: 'jsonforms/SET_CONFIG';
-    config: any;
-}
-export declare const setConfig: (config: any) => SetConfigAction;
-export declare const setValidationMode: (validationMode: ValidationMode) => SetValidationModeAction;
-export declare type UISchemaActions = AddUISchemaAction | RemoveUISchemaAction;
-export interface AddUISchemaAction {
-    type: 'jsonforms/ADD_UI_SCHEMA';
-    tester: UISchemaTester;
-    uischema: UISchemaElement;
-}
-export declare const registerUISchema: (tester: UISchemaTester, uischema: UISchemaElement) => AddUISchemaAction;
-export interface RemoveUISchemaAction {
-    type: 'jsonforms/REMOVE_UI_SCHEMA';
-    tester: UISchemaTester;
-}
-export declare const unregisterUISchema: (tester: UISchemaTester) => RemoveUISchemaAction;
-export declare type LocaleActions = SetLocaleAction | SetLocalizedSchemasAction | SetLocalizedUISchemasAction;
-export interface SetLocaleAction {
-    type: 'jsonforms/SET_LOCALE';
-    locale: string;
-}
-export declare const setLocale: (locale: string) => SetLocaleAction;
-export interface SetLocalizedSchemasAction {
-    type: 'jsonforms/SET_LOCALIZED_SCHEMAS';
-    localizedSchemas: Map<string, JsonSchema>;
-}
-export declare const setLocalizedSchemas: (localizedSchemas: Map<string, JsonSchema>) => SetLocalizedSchemasAction;
-export interface SetSchemaAction {
-    type: 'jsonforms/SET_SCHEMA';
-    schema: JsonSchema;
-}
-export declare const setSchema: (schema: JsonSchema) => SetSchemaAction;
-export interface SetLocalizedUISchemasAction {
-    type: 'jsonforms/SET_LOCALIZED_UISCHEMAS';
-    localizedUISchemas: Map<string, UISchemaElement>;
-}
-export declare const setLocalizedUISchemas: (localizedUISchemas: Map<string, UISchemaElement>) => SetLocalizedUISchemasAction;
-export interface SetUISchemaAction {
-    type: 'jsonforms/SET_UISCHEMA';
-    uischema: UISchemaElement;
-}
-export declare const setUISchema: (uischema: UISchemaElement) => SetUISchemaAction;
+import AJV, { ErrorObject } from 'ajv';
+import { JsonSchema, UISchemaElement } from '../models';
+import { RankedTester } from '../testers';
+import { UISchemaTester, ValidationMode } from '../reducers';
+import { ErrorTranslator, Translator } from '../i18n';
+export declare const INIT: 'jsonforms/INIT';
+export declare const UPDATE_CORE: 'jsonforms/UPDATE_CORE';
+export declare const SET_AJV: 'jsonforms/SET_AJV';
+export declare const UPDATE_DATA: 'jsonforms/UPDATE';
+export declare const UPDATE_ERRORS: 'jsonforms/UPDATE_ERRORS';
+export declare const VALIDATE: 'jsonforms/VALIDATE';
+export declare const ADD_RENDERER: 'jsonforms/ADD_RENDERER';
+export declare const REMOVE_RENDERER: 'jsonforms/REMOVE_RENDERER';
+export declare const ADD_CELL: 'jsonforms/ADD_CELL';
+export declare const REMOVE_CELL: 'jsonforms/REMOVE_CELL';
+export declare const SET_CONFIG: 'jsonforms/SET_CONFIG';
+export declare const ADD_UI_SCHEMA: 'jsonforms/ADD_UI_SCHEMA';
+export declare const REMOVE_UI_SCHEMA: 'jsonforms/REMOVE_UI_SCHEMA';
+export declare const SET_SCHEMA: 'jsonforms/SET_SCHEMA';
+export declare const SET_UISCHEMA: 'jsonforms/SET_UISCHEMA';
+export declare const SET_VALIDATION_MODE: 'jsonforms/SET_VALIDATION_MODE';
+export declare const SET_LOCALE: 'jsonforms/SET_LOCALE';
+export declare const SET_TRANSLATOR: 'jsonforms/SET_TRANSLATOR';
+export declare const UPDATE_I18N: 'jsonforms/UPDATE_I18N';
+export declare const ADD_DEFAULT_DATA: 'jsonforms/ADD_DEFAULT_DATA';
+export declare const REMOVE_DEFAULT_DATA: 'jsonforms/REMOVE_DEFAULT_DATA';
+export declare 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;
+}
+export interface UpdateCoreAction {
+    type: 'jsonforms/UPDATE_CORE';
+    data?: any;
+    schema?: JsonSchema;
+    uischema?: UISchemaElement;
+    options?: InitActionOptions | AJV;
+}
+export interface InitActionOptions {
+    ajv?: AJV;
+    validationMode?: ValidationMode;
+}
+export interface SetValidationModeAction {
+    type: 'jsonforms/SET_VALIDATION_MODE';
+    validationMode: ValidationMode;
+}
+export declare const init: (data: any, schema?: JsonSchema, uischema?: UISchemaElement, options?: InitActionOptions | AJV) => {
+    type: "jsonforms/INIT";
+    data: any;
+    schema: JsonSchema;
+    uischema: UISchemaElement;
+    options: InitActionOptions | AJV;
+};
+export declare const updateCore: (data: any, schema: JsonSchema, uischema?: UISchemaElement, options?: AJV | InitActionOptions) => UpdateCoreAction;
+export interface RegisterDefaultDataAction {
+    type: 'jsonforms/ADD_DEFAULT_DATA';
+    schemaPath: string;
+    data: any;
+}
+export declare const registerDefaultData: (schemaPath: string, data: any) => {
+    type: "jsonforms/ADD_DEFAULT_DATA";
+    schemaPath: string;
+    data: any;
+};
+export interface UnregisterDefaultDataAction {
+    type: 'jsonforms/REMOVE_DEFAULT_DATA';
+    schemaPath: string;
+}
+export declare const unregisterDefaultData: (schemaPath: string) => {
+    type: "jsonforms/REMOVE_DEFAULT_DATA";
+    schemaPath: string;
+};
+export interface SetAjvAction {
+    type: 'jsonforms/SET_AJV';
+    ajv: AJV;
+}
+export declare const setAjv: (ajv: AJV) => {
+    type: "jsonforms/SET_AJV";
+    ajv: AJV;
+};
+export declare const update: (path: string, updater: (existingData: any) => any) => UpdateAction;
+export declare const updateErrors: (errors: ErrorObject[]) => UpdateErrorsAction;
+export interface AddRendererAction {
+    type: 'jsonforms/ADD_RENDERER';
+    tester: RankedTester;
+    renderer: any;
+}
+export declare const registerRenderer: (tester: RankedTester, renderer: any) => {
+    type: "jsonforms/ADD_RENDERER";
+    tester: RankedTester;
+    renderer: any;
+};
+export interface AddCellRendererAction {
+    type: 'jsonforms/ADD_CELL';
+    tester: RankedTester;
+    cell: any;
+}
+export declare const registerCell: (tester: RankedTester, cell: any) => {
+    type: "jsonforms/ADD_CELL";
+    tester: RankedTester;
+    cell: any;
+};
+export interface RemoveCellRendererAction {
+    type: 'jsonforms/REMOVE_CELL';
+    tester: RankedTester;
+    cell: any;
+}
+export declare const unregisterCell: (tester: RankedTester, cell: any) => {
+    type: "jsonforms/REMOVE_CELL";
+    tester: RankedTester;
+    cell: any;
+};
+export interface RemoveRendererAction {
+    type: 'jsonforms/REMOVE_RENDERER';
+    tester: RankedTester;
+    renderer: any;
+}
+export declare const unregisterRenderer: (tester: RankedTester, renderer: any) => {
+    type: "jsonforms/REMOVE_RENDERER";
+    tester: RankedTester;
+    renderer: any;
+};
+export interface SetConfigAction {
+    type: 'jsonforms/SET_CONFIG';
+    config: any;
+}
+export declare const setConfig: (config: any) => SetConfigAction;
+export declare const setValidationMode: (validationMode: ValidationMode) => SetValidationModeAction;
+export declare type UISchemaActions = AddUISchemaAction | RemoveUISchemaAction;
+export interface AddUISchemaAction {
+    type: 'jsonforms/ADD_UI_SCHEMA';
+    tester: UISchemaTester;
+    uischema: UISchemaElement;
+}
+export declare const registerUISchema: (tester: UISchemaTester, uischema: UISchemaElement) => AddUISchemaAction;
+export interface RemoveUISchemaAction {
+    type: 'jsonforms/REMOVE_UI_SCHEMA';
+    tester: UISchemaTester;
+}
+export declare const unregisterUISchema: (tester: UISchemaTester) => RemoveUISchemaAction;
+export declare type I18nActions = SetLocaleAction | SetTranslatorAction | UpdateI18nAction;
+export interface SetLocaleAction {
+    type: 'jsonforms/SET_LOCALE';
+    locale: string | undefined;
+}
+export declare const setLocale: (locale: string | undefined) => SetLocaleAction;
+export interface SetSchemaAction {
+    type: 'jsonforms/SET_SCHEMA';
+    schema: JsonSchema;
+}
+export declare const setSchema: (schema: JsonSchema) => SetSchemaAction;
+export interface SetTranslatorAction {
+    type: 'jsonforms/SET_TRANSLATOR';
+    translator?: Translator;
+    errorTranslator?: ErrorTranslator;
+}
+export declare const setTranslator: (translator?: Translator, errorTranslator?: ErrorTranslator) => SetTranslatorAction;
+export interface UpdateI18nAction {
+    type: 'jsonforms/UPDATE_I18N';
+    locale: string | undefined;
+    translator: Translator | undefined;
+    errorTranslator: ErrorTranslator | undefined;
+}
+export declare const updateI18n: (locale: string | undefined, translator: Translator | undefined, errorTranslator: ErrorTranslator | undefined) => UpdateI18nAction;
+export interface SetUISchemaAction {
+    type: 'jsonforms/SET_UISCHEMA';
+    uischema: UISchemaElement;
+}
+export declare const setUISchema: (uischema: UISchemaElement) => SetUISchemaAction;

package/lib/actions/index.d.ts

@@ -1 +1 @@
-export * from './actions';
+export * from './actions';

package/lib/configDefault.d.ts

@@ -1,6 +1,6 @@
-export declare const configDefault: {
-    restrict: boolean;
-    trim: boolean;
-    showUnfocusedDescription: boolean;
-    hideRequiredAsterisk: boolean;
-};
+export declare const configDefault: {
+    restrict: boolean;
+    trim: boolean;
+    showUnfocusedDescription: boolean;
+    hideRequiredAsterisk: boolean;
+};

package/lib/generators/Generate.d.ts

@@ -1,6 +1,6 @@
-import { ControlElement, JsonSchema, UISchemaElement } from '../';
-export declare const Generate: {
-    jsonSchema(instance: Object, options?: any): JsonSchema;
-    uiSchema(jsonSchema: JsonSchema, layoutType?: string, prefix?: string, rootSchema?: JsonSchema): UISchemaElement;
-    controlElement(ref: string): ControlElement;
-};
+import { ControlElement, JsonSchema, UISchemaElement } from '../';
+export declare const Generate: {
+    jsonSchema(instance: Object, options?: any): JsonSchema;
+    uiSchema(jsonSchema: JsonSchema, layoutType?: string, prefix?: string, rootSchema?: JsonSchema): UISchemaElement;
+    controlElement(ref: string): ControlElement;
+};

package/lib/generators/index.d.ts

@@ -1,3 +1,3 @@
-export * from './Generate';
-export * from './schema';
-export * from './uischema';
+export * from './Generate';
+export * from './schema';
+export * from './uischema';

package/lib/generators/schema.d.ts

@@ -1,8 +1,8 @@
-import { JsonSchema4 } from '../models';
-/**
- * Generate a JSON schema based on the given data and any additional options.
- * @param {Object} instance the data to create a JSON schema for
- * @param {any} options any additional options that may alter the generated JSON schema
- * @returns {JsonSchema} the generated schema
- */
-export declare const generateJsonSchema: (instance: Object, options?: any) => JsonSchema4;
+import { JsonSchema4 } from '../models';
+/**
+ * Generate a JSON schema based on the given data and any additional options.
+ * @param {Object} instance the data to create a JSON schema for
+ * @param {any} options any additional options that may alter the generated JSON schema
+ * @returns {JsonSchema} the generated schema
+ */
+export declare const generateJsonSchema: (instance: Object, options?: any) => JsonSchema4;

package/lib/generators/uischema.d.ts

@@ -1,12 +1,12 @@
-import { ControlElement, JsonSchema, UISchemaElement } from '../models';
-/**
- * Creates a IControlObject with the given label referencing the given ref
- */
-export declare const createControlElement: (ref: string) => ControlElement;
-/**
- * Generate a default UI schema.
- * @param {JsonSchema} jsonSchema the JSON schema to generated a UI schema for
- * @param {string} layoutType the desired layout type for the root layout
- *        of the generated UI schema
- */
-export declare const generateDefaultUISchema: (jsonSchema: JsonSchema, layoutType?: string, prefix?: string, rootSchema?: JsonSchema) => UISchemaElement;
+import { ControlElement, JsonSchema, UISchemaElement } from '../models';
+/**
+ * Creates a IControlObject with the given label referencing the given ref
+ */
+export declare const createControlElement: (ref: string) => ControlElement;
+/**
+ * Generate a default UI schema.
+ * @param {JsonSchema} jsonSchema the JSON schema to generated a UI schema for
+ * @param {string} layoutType the desired layout type for the root layout
+ *        of the generated UI schema
+ */
+export declare const generateDefaultUISchema: (jsonSchema: JsonSchema, layoutType?: string, prefix?: string, rootSchema?: JsonSchema) => UISchemaElement;

package/lib/i18n/i18nTypes.d.ts

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

package/lib/i18n/i18nUtil.d.ts

@@ -0,0 +1,18 @@
+import { ErrorObject } from 'ajv';
+import { UISchemaElement } from '../models';
+import { i18nJsonSchema, ErrorTranslator, Translator } from './i18nTypes';
+export declare const getI18nKeyPrefixBySchema: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined) => string | 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 declare const transformPathToI18nPrefix: (path: string) => string;
+export declare const getI18nKeyPrefix: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined, path: string | undefined) => string | undefined;
+export declare const getI18nKey: (schema: i18nJsonSchema | undefined, uischema: UISchemaElement | undefined, path: string | undefined, key: string) => string | undefined;
+export declare const defaultTranslator: Translator;
+export declare const defaultErrorTranslator: ErrorTranslator;
+/**
+ * Returns the determined error message for the given errors.
+ * All errors must correspond to the given schema, uischema or path.
+ */
+export declare const getCombinedErrorMessage: (errors: ErrorObject[], et: ErrorTranslator, t: Translator, schema?: i18nJsonSchema, uischema?: UISchemaElement, path?: string) => string;

package/lib/i18n/index.d.ts

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

package/lib/index.d.ts

@@ -1,10 +1,11 @@
-export * from './actions';
-export * as Actions from './actions';
-export * from './generators';
-export * from './models';
-export * from './reducers';
-export * from './testers';
-export * as Test from './testers';
-export * from './util';
-export * from './Helpers';
-export * from './store';
+export * from './actions';
+export * as Actions from './actions';
+export * from './generators';
+export * from './models';
+export * from './reducers';
+export * from './testers';
+export * as Test from './testers';
+export * from './util';
+export * from './Helpers';
+export * from './store';
+export * from './i18n';