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

package/lib/testers/testers.d.ts

@@ -1,203 +1,203 @@
-import { Categorization, ControlElement, JsonSchema, UISchemaElement } from '../models';
-/**
- * Constant that indicates that a tester is not capable of handling
- * a combination of schema/data.
- * @type {number}
- */
-export declare const NOT_APPLICABLE = -1;
-/**
- * A tester is a function that receives an UI schema and a JSON schema and returns a boolean.
- */
-export declare type Tester = (uischema: UISchemaElement, schema: JsonSchema) => boolean;
-/**
- * A ranked tester associates a tester with a number.
- */
-export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema) => number;
-export declare const isControl: (uischema: any) => uischema is ControlElement;
-/**
- * Only applicable for Controls.
- *
- * This function checks whether the given UI schema is of type Control
- * and if so, resolves the sub-schema referenced by the control and applies
- * the given predicate
- *
- * @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;
-/**
- * Only applicable for Controls.
- *
- * This function checks whether the given UI schema is of type Control
- * and if so, resolves the sub-schema referenced by the control and checks
- * whether the type of the sub-schema matches the expected one.
- *
- * @param {string} expectedType the expected type of the resolved sub-schema
- */
-export declare const schemaTypeIs: (expectedType: string) => Tester;
-/**
- * Only applicable for Controls.
- *
- * This function checks whether the given UI schema is of type Control
- * and if so, resolves the sub-schema referenced by the control and checks
- * whether the format of the sub-schema matches the expected one.
- *
- * @param {string} expectedFormat the expected format of the resolved sub-schema
- */
-export declare const formatIs: (expectedFormat: string) => Tester;
-/**
- * Checks whether the given UI schema has the expected type.
- *
- * @param {string} expected the expected UI schema type
- */
-export declare const uiTypeIs: (expected: string) => Tester;
-/**
- * Checks whether the given UI schema has an option with the given
- * name and whether it has the expected value. If no options property
- * is set, returns false.
- *
- * @param {string} optionName the name of the option to check
- * @param {any} optionValue the expected value of the option
- */
-export declare const optionIs: (optionName: string, optionValue: any) => Tester;
-/**
- * Only applicable for Controls.
- *
- * Checks whether the scope of a control ends with the expected string.
- *
- * @param {string} expected the expected ending of the reference
- */
-export declare const scopeEndsWith: (expected: string) => Tester;
-/**
- * Only applicable for Controls.
- *
- * Checks whether the last segment of the scope matches the expected string.
- *
- * @param {string} expected the expected ending of the reference
- */
-export declare const scopeEndIs: (expected: string) => Tester;
-/**
- * A tester that allow composing other testers by && them.
- *
- * @param {Array<Tester>} testers the testers to be composed
- */
-export declare const and: (...testers: Tester[]) => Tester;
-/**
- * A tester that allow composing other testers by || them.
- *
- * @param {Array<Tester>} testers the testers to be composed
- */
-export declare const or: (...testers: Tester[]) => Tester;
-/**
- * Create a ranked tester that will associate a number with a given tester, if the
- * latter returns true.
- *
- * @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;
-/**
- * Default tester for boolean.
- * @type {RankedTester}
- */
-export declare const isBooleanControl: Tester;
-export declare const isObjectControl: Tester;
-export declare const isAllOfControl: Tester;
-export declare const isAnyOfControl: Tester;
-export declare const isOneOfControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * has an enum.
- * @type {Tester}
- */
-export declare const isEnumControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * has an enum based on oneOf.
- * @type {Tester}
- */
-export declare const isOneOfEnumControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * is of type integer
- * @type {Tester}
- */
-export declare const isIntegerControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * is of type number
- * @type {Tester}
- */
-export declare const isNumberControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * is of type string
- * @type {Tester}
- */
-export declare const isStringControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if is has
- * a 'multi' option.
- * @type {Tester}
- */
-export declare const isMultiLineControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and whether the schema
- * or uischema options has a 'date' format.
- * @type {Tester}
- */
-export declare const isDateControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and whether the schema
- * or the uischema options has a 'time' format.
- * @type {Tester}
- */
-export declare const isTimeControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and whether the schema
- * or the uischema options has a 'date-time' format.
- * @type {Tester}
- */
-export declare const isDateTimeControl: Tester;
-/**
- * Tests whether the given schema is an array of objects.
- * @type {Tester}
- */
-export declare const isObjectArray: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * is an array of objects.
- * @type {Tester}
- */
-export declare const isObjectArrayControl: Tester;
-export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema) => boolean;
-/**
- * Synonym for isObjectArrayControl
- */
-export declare const isArrayObjectControl: Tester;
-/**
- * Tests whether the given UI schema is of type Control and if the schema
- * is an array of a primitive type.
- * @type {Tester}
- */
-export declare const isPrimitiveArrayControl: Tester;
-/**
- * Tests whether a given UI schema is of type Control,
- * if the schema is of type number or integer and
- * whether the schema defines a numerical range with a default value.
- * @type {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
- * @type {Tester}
- */
-export declare const isNumberFormatControl: Tester;
-export declare const isCategorization: (category: UISchemaElement) => category is Categorization;
-export declare const isCategory: (uischema: UISchemaElement) => boolean;
-export declare const hasCategory: (categorization: Categorization) => boolean;
-export declare const categorizationHasCategory: (uischema: UISchemaElement) => boolean;
-export declare const not: (tester: Tester) => Tester;
+import { Categorization, ControlElement, JsonSchema, UISchemaElement } from '../models';
+/**
+ * Constant that indicates that a tester is not capable of handling
+ * a combination of schema/data.
+ * @type {number}
+ */
+export declare const NOT_APPLICABLE = -1;
+/**
+ * A tester is a function that receives an UI schema and a JSON schema and returns a boolean.
+ */
+export declare type Tester = (uischema: UISchemaElement, schema: JsonSchema) => boolean;
+/**
+ * A ranked tester associates a tester with a number.
+ */
+export declare type RankedTester = (uischema: UISchemaElement, schema: JsonSchema) => number;
+export declare const isControl: (uischema: any) => uischema is ControlElement;
+/**
+ * Only applicable for Controls.
+ *
+ * This function checks whether the given UI schema is of type Control
+ * and if so, resolves the sub-schema referenced by the control and applies
+ * the given predicate
+ *
+ * @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;
+/**
+ * Only applicable for Controls.
+ *
+ * This function checks whether the given UI schema is of type Control
+ * and if so, resolves the sub-schema referenced by the control and checks
+ * whether the type of the sub-schema matches the expected one.
+ *
+ * @param {string} expectedType the expected type of the resolved sub-schema
+ */
+export declare const schemaTypeIs: (expectedType: string) => Tester;
+/**
+ * Only applicable for Controls.
+ *
+ * This function checks whether the given UI schema is of type Control
+ * and if so, resolves the sub-schema referenced by the control and checks
+ * whether the format of the sub-schema matches the expected one.
+ *
+ * @param {string} expectedFormat the expected format of the resolved sub-schema
+ */
+export declare const formatIs: (expectedFormat: string) => Tester;
+/**
+ * Checks whether the given UI schema has the expected type.
+ *
+ * @param {string} expected the expected UI schema type
+ */
+export declare const uiTypeIs: (expected: string) => Tester;
+/**
+ * Checks whether the given UI schema has an option with the given
+ * name and whether it has the expected value. If no options property
+ * is set, returns false.
+ *
+ * @param {string} optionName the name of the option to check
+ * @param {any} optionValue the expected value of the option
+ */
+export declare const optionIs: (optionName: string, optionValue: any) => Tester;
+/**
+ * Only applicable for Controls.
+ *
+ * Checks whether the scope of a control ends with the expected string.
+ *
+ * @param {string} expected the expected ending of the reference
+ */
+export declare const scopeEndsWith: (expected: string) => Tester;
+/**
+ * Only applicable for Controls.
+ *
+ * Checks whether the last segment of the scope matches the expected string.
+ *
+ * @param {string} expected the expected ending of the reference
+ */
+export declare const scopeEndIs: (expected: string) => Tester;
+/**
+ * A tester that allow composing other testers by && them.
+ *
+ * @param {Array<Tester>} testers the testers to be composed
+ */
+export declare const and: (...testers: Tester[]) => Tester;
+/**
+ * A tester that allow composing other testers by || them.
+ *
+ * @param {Array<Tester>} testers the testers to be composed
+ */
+export declare const or: (...testers: Tester[]) => Tester;
+/**
+ * Create a ranked tester that will associate a number with a given tester, if the
+ * latter returns true.
+ *
+ * @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;
+/**
+ * Default tester for boolean.
+ * @type {RankedTester}
+ */
+export declare const isBooleanControl: Tester;
+export declare const isObjectControl: Tester;
+export declare const isAllOfControl: Tester;
+export declare const isAnyOfControl: Tester;
+export declare const isOneOfControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * has an enum.
+ * @type {Tester}
+ */
+export declare const isEnumControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * has an enum based on oneOf.
+ * @type {Tester}
+ */
+export declare const isOneOfEnumControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * is of type integer
+ * @type {Tester}
+ */
+export declare const isIntegerControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * is of type number
+ * @type {Tester}
+ */
+export declare const isNumberControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * is of type string
+ * @type {Tester}
+ */
+export declare const isStringControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if is has
+ * a 'multi' option.
+ * @type {Tester}
+ */
+export declare const isMultiLineControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and whether the schema
+ * or uischema options has a 'date' format.
+ * @type {Tester}
+ */
+export declare const isDateControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and whether the schema
+ * or the uischema options has a 'time' format.
+ * @type {Tester}
+ */
+export declare const isTimeControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and whether the schema
+ * or the uischema options has a 'date-time' format.
+ * @type {Tester}
+ */
+export declare const isDateTimeControl: Tester;
+/**
+ * Tests whether the given schema is an array of objects.
+ * @type {Tester}
+ */
+export declare const isObjectArray: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * is an array of objects.
+ * @type {Tester}
+ */
+export declare const isObjectArrayControl: Tester;
+export declare const isObjectArrayWithNesting: (uischema: UISchemaElement, schema: JsonSchema) => boolean;
+/**
+ * Synonym for isObjectArrayControl
+ */
+export declare const isArrayObjectControl: Tester;
+/**
+ * Tests whether the given UI schema is of type Control and if the schema
+ * is an array of a primitive type.
+ * @type {Tester}
+ */
+export declare const isPrimitiveArrayControl: Tester;
+/**
+ * Tests whether a given UI schema is of type Control,
+ * if the schema is of type number or integer and
+ * whether the schema defines a numerical range with a default value.
+ * @type {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
+ * @type {Tester}
+ */
+export declare const isNumberFormatControl: Tester;
+export declare const isCategorization: (category: UISchemaElement) => category is Categorization;
+export declare const isCategory: (uischema: UISchemaElement) => boolean;
+export declare const hasCategory: (categorization: Categorization) => boolean;
+export declare const categorizationHasCategory: (uischema: UISchemaElement) => boolean;
+export declare const not: (tester: Tester) => Tester;

package/lib/util/Formatted.d.ts

@@ -1,19 +1,19 @@
-/**
- * Interface for mapping a given type to a formatted string and back.
- */
-export interface Formatted<A> {
-    /**
-     * Format the given value
-     *
-     * @param {A} value the value to be formatted
-     * @returns {string} the formatted string
-     */
-    toFormatted(value: A): string;
-    /**
-     * Retrieve a value from a given string.
-     *
-     * @param {string} formatted the format string from which to obtain a value
-     * @returns {A} the obtained value
-     */
-    fromFormatted(formatted: string): A;
-}
+/**
+ * Interface for mapping a given type to a formatted string and back.
+ */
+export interface Formatted<A> {
+    /**
+     * Format the given value
+     *
+     * @param {A} value the value to be formatted
+     * @returns {string} the formatted string
+     */
+    toFormatted(value: A): string;
+    /**
+     * Retrieve a value from a given string.
+     *
+     * @param {string} formatted the format string from which to obtain a value
+     * @returns {A} the obtained value
+     */
+    fromFormatted(formatted: string): A;
+}

package/lib/util/array.d.ts

@@ -1,3 +1,3 @@
-declare const moveUp: (array: any[], toMove: number) => void;
-declare const moveDown: (array: any[], toMove: number) => void;
-export { moveUp, moveDown };
+declare const moveUp: (array: any[], toMove: number) => void;
+declare const moveDown: (array: any[], toMove: number) => void;
+export { moveUp, moveDown };

package/lib/util/cell.d.ts

@@ -1,79 +1,79 @@
-import { JsonFormsCellRendererRegistryEntry } from '../reducers';
-import { AnyAction, Dispatch } from './type';
-import { DispatchPropsOfControl, OwnPropsOfControl, OwnPropsOfEnum, StatePropsOfScopedRenderer } from './renderer';
-import { JsonFormsState } from '../store';
-import { JsonSchema } from '../models';
-export { JsonFormsCellRendererRegistryEntry };
-export interface OwnPropsOfCell extends OwnPropsOfControl {
-    data?: any;
-}
-/**
- * State props of a cell.
- */
-export interface StatePropsOfCell extends StatePropsOfScopedRenderer {
-    isValid: boolean;
-    rootSchema: JsonSchema;
-}
-export interface OwnPropsOfEnumCell extends OwnPropsOfCell, OwnPropsOfEnum {
-}
-/**
- * State props of a cell for enum cell
- */
-export interface StatePropsOfEnumCell extends StatePropsOfCell, OwnPropsOfEnum {
-}
-/**
- * Props of an enum cell.
- */
-export interface EnumCellProps extends StatePropsOfEnumCell, DispatchPropsOfControl {
-}
-export declare type DispatchPropsOfCell = DispatchPropsOfControl;
-/**
- * Props of a cell.
- */
-export interface CellProps extends StatePropsOfCell, DispatchPropsOfCell {
-}
-/**
- * Registers the given cell renderer when a JSON Forms store is created.
- * @param {RankedTester} tester
- * @param cell the cell to be registered
- * @returns {any}
- */
-export interface DispatchCellStateProps extends StatePropsOfCell {
-    cells?: JsonFormsCellRendererRegistryEntry[];
-}
-/**
- * Map state to cell props.
- *
- * @param state JSONForms state tree
- * @param ownProps any own props
- * @returns {StatePropsOfCell} state props of a cell
- */
-export declare const mapStateToCellProps: (state: JsonFormsState, ownProps: OwnPropsOfCell) => StatePropsOfCell;
-export declare const mapStateToDispatchCellProps: (state: JsonFormsState, ownProps: OwnPropsOfCell) => DispatchCellStateProps;
-export interface DispatchCellProps extends DispatchCellStateProps {
-}
-/**
- * Default mapStateToCellProps for enum cell. Options is used for populating dropdown list
- * @param state
- * @param ownProps
- * @returns {StatePropsOfEnumCell}
- */
-export declare const defaultMapStateToEnumCellProps: (state: JsonFormsState, ownProps: OwnPropsOfEnumCell) => StatePropsOfEnumCell;
-/**
- * mapStateToOneOfEnumCellProps for one of enum cell. Options is used for populating dropdown list from oneOf
- * @param state
- * @param ownProps
- * @returns {StatePropsOfEnumCell}
- */
-export declare const mapStateToOneOfEnumCellProps: (state: JsonFormsState, ownProps: OwnPropsOfEnumCell) => StatePropsOfEnumCell;
-/**
- * Synonym for mapDispatchToControlProps.
- *
- * @type {(dispatch) => {handleChange(path, value): void}}
- */
-export declare const mapDispatchToCellProps: (dispatch: Dispatch<AnyAction>) => DispatchPropsOfControl;
-/**
- * Default dispatch to control props which can be customized to set handleChange action
- *
- */
-export declare const defaultMapDispatchToControlProps: (dispatch: Dispatch<AnyAction>, ownProps: any) => DispatchPropsOfControl;
+import type { JsonFormsCellRendererRegistryEntry } from '../reducers';
+import { AnyAction, Dispatch } from './type';
+import { DispatchPropsOfControl, OwnPropsOfControl, OwnPropsOfEnum, StatePropsOfScopedRenderer } from './renderer';
+import { JsonFormsState } from '../store';
+import { JsonSchema } from '../models';
+export type { JsonFormsCellRendererRegistryEntry };
+export interface OwnPropsOfCell extends OwnPropsOfControl {
+    data?: any;
+}
+/**
+ * State props of a cell.
+ */
+export interface StatePropsOfCell extends StatePropsOfScopedRenderer {
+    isValid: boolean;
+    rootSchema: JsonSchema;
+}
+export interface OwnPropsOfEnumCell extends OwnPropsOfCell, OwnPropsOfEnum {
+}
+/**
+ * State props of a cell for enum cell
+ */
+export interface StatePropsOfEnumCell extends StatePropsOfCell, OwnPropsOfEnum {
+}
+/**
+ * Props of an enum cell.
+ */
+export interface EnumCellProps extends StatePropsOfEnumCell, DispatchPropsOfControl {
+}
+export declare type DispatchPropsOfCell = DispatchPropsOfControl;
+/**
+ * Props of a cell.
+ */
+export interface CellProps extends StatePropsOfCell, DispatchPropsOfCell {
+}
+/**
+ * Registers the given cell renderer when a JSON Forms store is created.
+ * @param {RankedTester} tester
+ * @param cell the cell to be registered
+ * @returns {any}
+ */
+export interface DispatchCellStateProps extends StatePropsOfCell {
+    cells?: JsonFormsCellRendererRegistryEntry[];
+}
+/**
+ * Map state to cell props.
+ *
+ * @param state JSONForms state tree
+ * @param ownProps any own props
+ * @returns {StatePropsOfCell} state props of a cell
+ */
+export declare const mapStateToCellProps: (state: JsonFormsState, ownProps: OwnPropsOfCell) => StatePropsOfCell;
+export declare const mapStateToDispatchCellProps: (state: JsonFormsState, ownProps: OwnPropsOfCell) => DispatchCellStateProps;
+export interface DispatchCellProps extends DispatchCellStateProps {
+}
+/**
+ * Default mapStateToCellProps for enum cell. Options is used for populating dropdown list
+ * @param state
+ * @param ownProps
+ * @returns {StatePropsOfEnumCell}
+ */
+export declare const defaultMapStateToEnumCellProps: (state: JsonFormsState, ownProps: OwnPropsOfEnumCell) => StatePropsOfEnumCell;
+/**
+ * mapStateToOneOfEnumCellProps for one of enum cell. Options is used for populating dropdown list from oneOf
+ * @param state
+ * @param ownProps
+ * @returns {StatePropsOfEnumCell}
+ */
+export declare const mapStateToOneOfEnumCellProps: (state: JsonFormsState, ownProps: OwnPropsOfEnumCell) => StatePropsOfEnumCell;
+/**
+ * Synonym for mapDispatchToControlProps.
+ *
+ * @type {(dispatch) => {handleChange(path, value): void}}
+ */
+export declare const mapDispatchToCellProps: (dispatch: Dispatch<AnyAction>) => DispatchPropsOfControl;
+/**
+ * Default dispatch to control props which can be customized to set handleChange action
+ *
+ */
+export declare const defaultMapDispatchToControlProps: (dispatch: Dispatch<AnyAction>, ownProps: any) => DispatchPropsOfControl;

package/lib/util/combinators.d.ts

@@ -1,10 +1,10 @@
-import { ControlElement, JsonSchema, UISchemaElement } from '../models';
-import { JsonFormsUISchemaRegistryEntry } from '../reducers';
-export interface CombinatorSubSchemaRenderInfo {
-    schema: JsonSchema;
-    uischema: UISchemaElement;
-    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[];
+import { ControlElement, JsonSchema, UISchemaElement } from '../models';
+import { JsonFormsUISchemaRegistryEntry } from '../reducers';
+export interface CombinatorSubSchemaRenderInfo {
+    schema: JsonSchema;
+    uischema: UISchemaElement;
+    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/ids.d.ts

@@ -1,3 +1,3 @@
-export declare const createId: (proposedId: string) => string;
-export declare const removeId: (id: string) => boolean;
-export declare const clearAllIds: () => void;
+export declare const createId: (proposedId: string) => string;
+export declare const removeId: (id: string) => boolean;
+export declare const clearAllIds: () => void;