@jsonforms/core 3.3.0-beta.0 → 3.3.0

package/lib/models/uischema.d.ts

@@ -1,231 +1,231 @@
-import type { JsonSchema } from './jsonSchema';
-/**
- * Interface for describing an UI schema element that is referencing
- * 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.
- */
-export interface Rule {
-    /**
-     * The effect of the rule
-     */
-    effect: RuleEffect;
-    /**
-     * The condition of the rule that must evaluate to true in order
-     * to trigger the effect.
-     */
-    condition: Condition;
-}
-/**
- * The different rule effects.
- */
-export declare enum RuleEffect {
-    /**
-     * Effect that hides the associated element.
-     */
-    HIDE = "HIDE",
-    /**
-     * Effect that shows the associated element.
-     */
-    SHOW = "SHOW",
-    /**
-     * Effect that enables the associated element.
-     */
-    ENABLE = "ENABLE",
-    /**
-     * Effect that disables the associated element.
-     */
-    DISABLE = "DISABLE"
-}
-/**
- * Represents a condition to be evaluated.
- */
-export interface Condition {
-    /**
-     * The type of condition.
-     */
-    readonly type?: string;
-}
-/**
- * A leaf condition.
- */
-export interface LeafCondition extends Condition, Scoped {
-    type: 'LEAF';
-    /**
-     * The expected value when evaluating the condition
-     */
-    expectedValue: any;
-}
-export interface SchemaBasedCondition extends Condition, Scoped {
-    schema: JsonSchema;
-    /**
-     * When the scope resolves to undefined and `failWhenUndefined` is set to `true`, the condition
-     * will fail. Therefore the reverse effect will be applied.
-     *
-     * Background:
-     * Most JSON Schemas will successfully validate against `undefined` data. Specifying that a
-     * condition shall fail when data is `undefined` requires to lift the scope to being able to use
-     * JSON Schema's `required`.
-     *
-     * Using `failWhenUndefined` allows to more conveniently express this condition.
-     */
-    failWhenUndefined?: boolean;
-}
-/**
- * A composable condition.
- */
-export interface ComposableCondition extends Condition {
-    conditions: Condition[];
-}
-/**
- * An or condition.
- */
-export interface OrCondition extends ComposableCondition {
-    type: 'OR';
-}
-/**
- * An and condition.
- */
-export interface AndCondition extends ComposableCondition {
-    type: 'AND';
-}
-/**
- * Common base interface for any UI schema element.
- */
-export interface UISchemaElement {
-    /**
-     * The type of this UI schema element.
-     */
-    type: string;
-    /**
-     * An optional rule.
-     */
-    rule?: Rule;
-    /**
-     * Any additional options.
-     */
-    options?: {
-        [key: string]: any;
-    };
-}
-/**
- * Represents a layout element which can order its children
- * in a specific way.
- */
-export interface Layout extends UISchemaElement {
-    /**
-     * The child elements of this layout.
-     */
-    elements: UISchemaElement[];
-}
-/**
- * A layout which orders its child elements vertically (i.e. from top to bottom).
- */
-export interface VerticalLayout extends Layout {
-    type: 'VerticalLayout';
-}
-/**
- * A layout which orders its children horizontally (i.e. from left to right).
- */
-export interface HorizontalLayout extends Layout {
-    type: 'HorizontalLayout';
-}
-/**
- * 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, Labelable, Internationalizable {
-    type: 'Group';
-}
-/**
- * Represents an object that can be used to configure a label.
- */
-export interface LabelDescription {
-    /**
-     * An optional text to be displayed.
-     */
-    text?: string;
-    /**
-     * Optional property that determines whether to show this label.
-     */
-    show?: boolean;
-}
-/**
- * A label element.
- */
-export interface LabelElement extends UISchemaElement, Internationalizable {
-    type: 'Label';
-    /**
-     * The text of label.
-     */
-    text: string;
-}
-/**
- * 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, Scoped, Labelable<string | boolean | LabelDescription>, Internationalizable {
-    type: 'Control';
-}
-/**
- * The category layout.
- */
-export interface Category extends Layout, Labeled, Internationalizable {
-    type: 'Category';
-}
-/**
- * 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, Labeled, Internationalizable {
-    type: 'Categorization';
-    /**
-     * 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>;
-export declare const isControlElement: (uiSchema: UISchemaElement) => uiSchema is ControlElement;
+import type { JsonSchema } from './jsonSchema';
+/**
+ * Interface for describing an UI schema element that is referencing
+ * 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.
+ */
+export interface Rule {
+    /**
+     * The effect of the rule
+     */
+    effect: RuleEffect;
+    /**
+     * The condition of the rule that must evaluate to true in order
+     * to trigger the effect.
+     */
+    condition: Condition;
+}
+/**
+ * The different rule effects.
+ */
+export declare enum RuleEffect {
+    /**
+     * Effect that hides the associated element.
+     */
+    HIDE = "HIDE",
+    /**
+     * Effect that shows the associated element.
+     */
+    SHOW = "SHOW",
+    /**
+     * Effect that enables the associated element.
+     */
+    ENABLE = "ENABLE",
+    /**
+     * Effect that disables the associated element.
+     */
+    DISABLE = "DISABLE"
+}
+/**
+ * Represents a condition to be evaluated.
+ */
+export interface Condition {
+    /**
+     * The type of condition.
+     */
+    readonly type?: string;
+}
+/**
+ * A leaf condition.
+ */
+export interface LeafCondition extends Condition, Scoped {
+    type: 'LEAF';
+    /**
+     * The expected value when evaluating the condition
+     */
+    expectedValue: any;
+}
+export interface SchemaBasedCondition extends Condition, Scoped {
+    schema: JsonSchema;
+    /**
+     * When the scope resolves to undefined and `failWhenUndefined` is set to `true`, the condition
+     * will fail. Therefore the reverse effect will be applied.
+     *
+     * Background:
+     * Most JSON Schemas will successfully validate against `undefined` data. Specifying that a
+     * condition shall fail when data is `undefined` requires to lift the scope to being able to use
+     * JSON Schema's `required`.
+     *
+     * Using `failWhenUndefined` allows to more conveniently express this condition.
+     */
+    failWhenUndefined?: boolean;
+}
+/**
+ * A composable condition.
+ */
+export interface ComposableCondition extends Condition {
+    conditions: Condition[];
+}
+/**
+ * An or condition.
+ */
+export interface OrCondition extends ComposableCondition {
+    type: 'OR';
+}
+/**
+ * An and condition.
+ */
+export interface AndCondition extends ComposableCondition {
+    type: 'AND';
+}
+/**
+ * Common base interface for any UI schema element.
+ */
+export interface UISchemaElement {
+    /**
+     * The type of this UI schema element.
+     */
+    type: string;
+    /**
+     * An optional rule.
+     */
+    rule?: Rule;
+    /**
+     * Any additional options.
+     */
+    options?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Represents a layout element which can order its children
+ * in a specific way.
+ */
+export interface Layout extends UISchemaElement {
+    /**
+     * The child elements of this layout.
+     */
+    elements: UISchemaElement[];
+}
+/**
+ * A layout which orders its child elements vertically (i.e. from top to bottom).
+ */
+export interface VerticalLayout extends Layout {
+    type: 'VerticalLayout';
+}
+/**
+ * A layout which orders its children horizontally (i.e. from left to right).
+ */
+export interface HorizontalLayout extends Layout {
+    type: 'HorizontalLayout';
+}
+/**
+ * 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, Labelable, Internationalizable {
+    type: 'Group';
+}
+/**
+ * Represents an object that can be used to configure a label.
+ */
+export interface LabelDescription {
+    /**
+     * An optional text to be displayed.
+     */
+    text?: string;
+    /**
+     * Optional property that determines whether to show this label.
+     */
+    show?: boolean;
+}
+/**
+ * A label element.
+ */
+export interface LabelElement extends UISchemaElement, Internationalizable {
+    type: 'Label';
+    /**
+     * The text of label.
+     */
+    text: string;
+}
+/**
+ * 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, Scoped, Labelable<string | boolean | LabelDescription>, Internationalizable {
+    type: 'Control';
+}
+/**
+ * The category layout.
+ */
+export interface Category extends Layout, Labeled, Internationalizable {
+    type: 'Category';
+}
+/**
+ * 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, Labeled, Internationalizable {
+    type: 'Categorization';
+    /**
+     * 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>;
+export declare const isControlElement: (uiSchema: UISchemaElement) => uiSchema is ControlElement;

package/lib/reducers/cells.d.ts

@@ -1,11 +1,11 @@
-import type { RankedTester } from '../testers';
-import { AddCellRendererAction, RemoveCellRendererAction } from '../actions';
-import type { Reducer } from '../util';
-type ValidCellReducerActions = AddCellRendererAction | RemoveCellRendererAction;
-export type JsonFormsCellRendererRegistryState = JsonFormsCellRendererRegistryEntry[];
-export interface JsonFormsCellRendererRegistryEntry {
-    tester: RankedTester;
-    cell: any;
-}
-export declare const cellReducer: Reducer<JsonFormsCellRendererRegistryState, ValidCellReducerActions>;
-export {};
+import type { RankedTester } from '../testers';
+import { AddCellRendererAction, RemoveCellRendererAction } from '../actions';
+import type { Reducer } from '../util';
+type ValidCellReducerActions = AddCellRendererAction | RemoveCellRendererAction;
+export type JsonFormsCellRendererRegistryState = JsonFormsCellRendererRegistryEntry[];
+export interface JsonFormsCellRendererRegistryEntry {
+    tester: RankedTester;
+    cell: any;
+}
+export declare const cellReducer: Reducer<JsonFormsCellRendererRegistryState, ValidCellReducerActions>;
+export {};

package/lib/reducers/config.d.ts

@@ -1,3 +1,3 @@
-import { SetConfigAction } from '../actions';
-import type { Reducer } from '../util';
-export declare const configReducer: Reducer<any, SetConfigAction>;
+import { SetConfigAction } from '../actions';
+import type { Reducer } from '../util';
+export declare const configReducer: Reducer<any, SetConfigAction>;

package/lib/reducers/core.d.ts

@@ -1,26 +1,26 @@
-import type Ajv from 'ajv';
-import type { ErrorObject, ValidateFunction } from 'ajv';
-import { CoreActions } from '../actions';
-import { Reducer } from '../util';
-import type { JsonSchema, UISchemaElement } from '../models';
-export declare const validate: (validator: ValidateFunction | undefined, data: any) => ErrorObject[];
-export type ValidationMode = 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation';
-export interface JsonFormsCore {
-    data: any;
-    schema: JsonSchema;
-    uischema: UISchemaElement;
-    errors?: ErrorObject[];
-    additionalErrors?: ErrorObject[];
-    validator?: ValidateFunction;
-    ajv?: Ajv;
-    validationMode?: ValidationMode;
-}
-export declare const coreReducer: Reducer<JsonFormsCore, CoreActions>;
-export declare const extractData: (state: JsonFormsCore) => any;
-export declare const extractSchema: (state: JsonFormsCore) => JsonSchema;
-export declare const extractUiSchema: (state: JsonFormsCore) => UISchemaElement;
-export declare const extractAjv: (state: JsonFormsCore) => Ajv;
-export declare const getControlPath: (error: ErrorObject) => any;
-export declare const errorsAt: (instancePath: string, schema: JsonSchema, matchPath: (path: string) => boolean) => (errors: ErrorObject[]) => ErrorObject[];
-export declare const errorAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsCore) => ErrorObject[];
-export declare const subErrorsAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsCore) => ErrorObject[];
+import type Ajv from 'ajv';
+import type { ErrorObject, ValidateFunction } from 'ajv';
+import { CoreActions } from '../actions';
+import { Reducer } from '../util';
+import type { JsonSchema, UISchemaElement } from '../models';
+export declare const validate: (validator: ValidateFunction | undefined, data: any) => ErrorObject[];
+export type ValidationMode = 'ValidateAndShow' | 'ValidateAndHide' | 'NoValidation';
+export interface JsonFormsCore {
+    data: any;
+    schema: JsonSchema;
+    uischema: UISchemaElement;
+    errors?: ErrorObject[];
+    additionalErrors?: ErrorObject[];
+    validator?: ValidateFunction;
+    ajv?: Ajv;
+    validationMode?: ValidationMode;
+}
+export declare const coreReducer: Reducer<JsonFormsCore, CoreActions>;
+export declare const extractData: (state: JsonFormsCore) => any;
+export declare const extractSchema: (state: JsonFormsCore) => JsonSchema;
+export declare const extractUiSchema: (state: JsonFormsCore) => UISchemaElement;
+export declare const extractAjv: (state: JsonFormsCore) => Ajv;
+export declare const getControlPath: (error: ErrorObject) => any;
+export declare const errorsAt: (instancePath: string, schema: JsonSchema, matchPath: (path: string) => boolean) => (errors: ErrorObject[]) => ErrorObject[];
+export declare const errorAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsCore) => ErrorObject[];
+export declare const subErrorsAt: (instancePath: string, schema: JsonSchema) => (state: JsonFormsCore) => ErrorObject[];

package/lib/reducers/default-data.d.ts

@@ -1,10 +1,10 @@
-import { RegisterDefaultDataAction, UnregisterDefaultDataAction } from '../actions';
-import type { Reducer } from '../util';
-export interface JsonFormsDefaultDataRegistryEntry {
-    schemaPath: string;
-    data: any;
-}
-type ValidDefaultDataActions = RegisterDefaultDataAction | UnregisterDefaultDataAction;
-export declare const defaultDataReducer: Reducer<JsonFormsDefaultDataRegistryEntry[], ValidDefaultDataActions>;
-export declare const extractDefaultData: (state: JsonFormsDefaultDataRegistryEntry[]) => JsonFormsDefaultDataRegistryEntry[];
-export {};
+import { RegisterDefaultDataAction, UnregisterDefaultDataAction } from '../actions';
+import type { Reducer } from '../util';
+export interface JsonFormsDefaultDataRegistryEntry {
+    schemaPath: string;
+    data: any;
+}
+type ValidDefaultDataActions = RegisterDefaultDataAction | UnregisterDefaultDataAction;
+export declare const defaultDataReducer: Reducer<JsonFormsDefaultDataRegistryEntry[], ValidDefaultDataActions>;
+export declare const extractDefaultData: (state: JsonFormsDefaultDataRegistryEntry[]) => JsonFormsDefaultDataRegistryEntry[];
+export {};

package/lib/reducers/i18n.d.ts

@@ -1,8 +1,8 @@
-import { JsonFormsI18nState } from '../i18n';
-import { I18nActions } from '../actions';
-import type { Reducer } from '../util';
-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;
-export declare const fetchErrorTranslator: (state?: JsonFormsI18nState) => import("../i18n").ErrorTranslator;
+import { JsonFormsI18nState } from '../i18n';
+import { I18nActions } from '../actions';
+import type { Reducer } from '../util';
+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;
+export declare const fetchErrorTranslator: (state?: JsonFormsI18nState) => import("../i18n").ErrorTranslator;

package/lib/reducers/index.d.ts

@@ -1,10 +1,10 @@
-export * from './cells';
-export * from './config';
-export * from './core';
-export * from './default-data';
-export * from './i18n';
-export * from './reducers';
-export * from './renderers';
-export * from './selectors';
-export * from './uischemas';
-export * from './middleware';
+export * from './cells';
+export * from './config';
+export * from './core';
+export * from './default-data';
+export * from './i18n';
+export * from './reducers';
+export * from './renderers';
+export * from './selectors';
+export * from './uischemas';
+export * from './middleware';

package/lib/reducers/middleware.d.ts

@@ -1,6 +1,6 @@
-import { CoreActions } from '../actions';
-import { JsonFormsCore } from './core';
-export interface Middleware {
-    (state: JsonFormsCore, action: CoreActions, defaultReducer: (state: JsonFormsCore, action: CoreActions) => JsonFormsCore): JsonFormsCore;
-}
-export declare const defaultMiddleware: Middleware;
+import { CoreActions } from '../actions';
+import { JsonFormsCore } from './core';
+export interface Middleware {
+    (state: JsonFormsCore, action: CoreActions, defaultReducer: (state: JsonFormsCore, action: CoreActions) => JsonFormsCore): JsonFormsCore;
+}
+export declare const defaultMiddleware: Middleware;