@jsonforms/core 3.3.0 → 3.4.0-alpha.1

package/src/i18n/selectors.ts

@@ -0,0 +1,67 @@
+/*
+  The MIT License
+  
+  Copyright (c) 2017-2019 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+  
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+  
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+*/
+
+import get from 'lodash/get';
+import {
+  ErrorTranslator,
+  JsonFormsI18nState,
+  Translator,
+  JsonFormsState,
+} from '../store';
+import { defaultErrorTranslator, defaultTranslator } from './i18nUtil';
+
+export const fetchLocale = (state?: JsonFormsI18nState) => {
+  if (state === undefined) {
+    return undefined;
+  }
+  return state.locale;
+};
+
+export const fetchTranslator = (state?: JsonFormsI18nState) => {
+  if (state === undefined) {
+    return defaultTranslator;
+  }
+  return state.translate;
+};
+
+export const fetchErrorTranslator = (state?: JsonFormsI18nState) => {
+  if (state === undefined) {
+    return defaultErrorTranslator;
+  }
+  return state.translateError;
+};
+
+export const getLocale = (state: JsonFormsState) =>
+  fetchLocale(get(state, 'jsonforms.i18n'));
+
+export const getTranslator =
+  () =>
+  (state: JsonFormsState): Translator =>
+    fetchTranslator(get(state, 'jsonforms.i18n'));
+
+export const getErrorTranslator =
+  () =>
+  (state: JsonFormsState): ErrorTranslator =>
+    fetchErrorTranslator(get(state, 'jsonforms.i18n'));

package/src/index.ts

@@ -31,7 +31,6 @@ export * from './reducers';
 export * from './testers';
 export * as Test from './testers';
 export * from './util';
-
-export * from './Helpers';
 export * from './store';
 export * from './i18n';
+export * from './mappers';

package/src/{util → mappers}/cell.ts

@@ -24,19 +24,7 @@
 */
 
 import isEmpty from 'lodash/isEmpty';
-import {
-  getErrorTranslator,
-  getAjv,
-  getConfig,
-  getData,
-  getErrorAt,
-  getSchema,
-  getTranslator,
-} from '../reducers';
-import type { JsonFormsCellRendererRegistryEntry } from '../reducers';
-import type { AnyAction, Dispatch } from './type';
-import { Resolve } from './util';
-import { isInherentlyEnabled, isVisible } from './runtime';
+import { isVisible, Resolve } from '../util';
 import {
   DispatchPropsOfControl,
   EnumOption,
@@ -47,9 +35,25 @@ import {
   OwnPropsOfEnum,
   StatePropsOfScopedRenderer,
 } from './renderer';
-import { getCombinedErrorMessage, getI18nKeyPrefix } from '../i18n';
-import type { JsonFormsState } from '../store';
+import {
+  getCombinedErrorMessage,
+  getErrorTranslator,
+  getI18nKeyPrefix,
+  getTranslator,
+} from '../i18n';
 import type { JsonSchema } from '../models';
+import {
+  AnyAction,
+  Dispatch,
+  getAjv,
+  getConfig,
+  getData,
+  getErrorAt,
+  getSchema,
+  JsonFormsCellRendererRegistryEntry,
+  JsonFormsState,
+} from '../store';
+import { isInherentlyEnabled } from './util';
 
 export interface OwnPropsOfCell extends OwnPropsOfControl {
   data?: any;

package/src/{util → mappers}/combinators.ts

@@ -24,8 +24,9 @@
 */
 
 import type { ControlElement, JsonSchema, UISchemaElement } from '../models';
-import { findUISchema, JsonFormsUISchemaRegistryEntry } from '../reducers';
-import { Resolve } from './util';
+import { findUISchema } from '../reducers';
+import { JsonFormsUISchemaRegistryEntry } from '../store';
+import { Resolve } from '../util/util';
 
 export interface CombinatorSubSchemaRenderInfo {
   schema: JsonSchema;

package/src/mappers/index.ts

@@ -0,0 +1,29 @@
+/*
+  The MIT License
+  
+  Copyright (c) 2024 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+  
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+  
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+*/
+
+export * from './renderer';
+export * from './cell';
+export * from './combinators';
+export * from './util';

package/src/{util → mappers}/renderer.ts

@@ -26,41 +26,21 @@
 import get from 'lodash/get';
 import {
   ControlElement,
-  isLabelable,
   JsonSchema,
   LabelElement,
   UISchemaElement,
 } from '../models';
-import {
-  getUISchemas,
-  getAjv,
-  getCells,
-  getConfig,
-  getData,
-  getErrorAt,
-  getErrorTranslator,
-  getRenderers,
-  getSchema,
-  getSubErrorsAt,
-  getTranslator,
-  getUiSchema,
-} from '../reducers';
+import type { RankedTester } from '../testers';
+import { CoreActions, update, UpdateArrayContext } from '../actions';
+import type { ErrorObject } from 'ajv';
 import type {
+  AnyAction,
+  Dispatch,
   JsonFormsCellRendererRegistryEntry,
   JsonFormsRendererRegistryEntry,
+  JsonFormsState,
   JsonFormsUISchemaRegistryEntry,
-} from '../reducers';
-import type { RankedTester } from '../testers';
-import { hasShowRule, isInherentlyEnabled, isVisible } from './runtime';
-import { computeChildLabel, createLabelDescriptionFrom } from './label';
-import type { CombinatorKeyword } from './combinators';
-import { moveDown, moveUp } from './array';
-import type { AnyAction, Dispatch } from './type';
-import { Resolve, convertDateToString, hasType } from './util';
-import { composePaths, composeWithUi } from './path';
-import { CoreActions, update, UpdateArrayContext } from '../actions';
-import type { ErrorObject } from 'ajv';
-import type { JsonFormsState } from '../store';
+} from '../store';
 import {
   deriveLabelForUISchemaElement,
   getCombinedErrorMessage,
@@ -68,17 +48,65 @@ import {
   getI18nKeyPrefix,
   getI18nKeyPrefixBySchema,
   getArrayTranslations,
-  Translator,
   CombinatorTranslations,
   getCombinatorTranslations,
   combinatorDefaultTranslations,
-} from '../i18n';
-import {
+  getTranslator,
+  getErrorTranslator,
   arrayDefaultTranslations,
   ArrayTranslations,
-} from '../i18n/arrayTranslations';
-import { resolveSchema } from './resolvers';
+} from '../i18n';
 import cloneDeep from 'lodash/cloneDeep';
+import {
+  composePaths,
+  composeWithUi,
+  convertDateToString,
+  createLabelDescriptionFrom,
+  findUiControl,
+  getFirstPrimitiveProp,
+  getPropPath,
+  hasShowRule,
+  hasType,
+  isEnumSchema,
+  isLabelable,
+  isOneOfEnumSchema,
+  isVisible,
+  Resolve,
+  resolveSchema,
+} from '../util';
+import {
+  Translator,
+  getAjv,
+  getCells,
+  getConfig,
+  getData,
+  getErrorAt,
+  getRenderers,
+  getSchema,
+  getSubErrorsAt,
+  getUISchemas,
+  getUiSchema,
+} from '../store';
+import { isInherentlyEnabled } from './util';
+import { CombinatorKeyword } from './combinators';
+import { isEqual } from 'lodash';
+
+const move = (array: any[], index: number, delta: number) => {
+  const newIndex: number = index + delta;
+  if (newIndex < 0 || newIndex >= array.length) {
+    return;
+  } // Already at the top or bottom.
+  const indexes: number[] = [index, newIndex].sort((a, b) => a - b); // Sort the indixes
+  array.splice(indexes[0], 2, array[indexes[1]], array[indexes[0]]);
+};
+
+export const moveUp = (array: any[], toMove: number) => {
+  move(array, toMove, -1);
+};
+
+export const moveDown = (array: any[], toMove: number) => {
+  move(array, toMove, 1);
+};
 
 const isRequired = (
   schema: JsonSchema,
@@ -726,6 +754,7 @@ export interface OwnPropsOfMasterListItem {
   handleSelect(index: number): () => void;
   removeItem(path: string, value: number): () => void;
   translations: ArrayTranslations;
+  disableRemove?: boolean;
 }
 
 export interface StatePropsOfMasterItem extends OwnPropsOfMasterListItem {
@@ -1133,6 +1162,8 @@ export interface StatePropsOfArrayLayout extends StatePropsOfControlWithDetail {
   data: number;
   translations: ArrayTranslations;
   minItems?: number;
+  disableRemove?: boolean;
+  disableAdd?: boolean;
 }
 /**
  * Map state to table props
@@ -1219,3 +1250,80 @@ export const mapStateToLabelProps = (
     cells: props.cells || getCells(state),
   };
 };
+
+/**
+ * Compute the child label title for array based controls
+ * @param data the data of the control
+ * @param childPath the child path
+ * @param childLabelProp the dotted path to the value used as child label
+ * @param {JsonSchema} schema the json schema for this control
+ * @param {JsonSchema} rootSchema the root json schema
+ * @param {Translator} translateFct the translator fonction
+ * @param {UISchemaElement} uiSchema the uiSchema of the control
+ */
+export const computeChildLabel = (
+  data: any,
+  childPath: string,
+  childLabelProp: string,
+  schema: JsonSchema,
+  rootSchema: JsonSchema,
+  translateFct: Translator,
+  uiSchema: UISchemaElement
+): string => {
+  const childData = Resolve.data(data, childPath);
+
+  if (!childLabelProp) {
+    childLabelProp = getFirstPrimitiveProp(schema);
+  }
+
+  // return early in case there is no prop we can query
+  if (!childLabelProp) {
+    return '';
+  }
+
+  const currentValue = get(childData, childLabelProp);
+
+  // in case there is no value, then we can't map it to an enum or oneOf
+  if (currentValue === undefined) {
+    return '';
+  }
+
+  // check whether the value is part of a oneOf or enum and needs to be translated
+  const childSchema = Resolve.schema(
+    schema,
+    '#' + getPropPath(childLabelProp),
+    rootSchema
+  );
+
+  let enumOption: EnumOption = undefined;
+  if (isEnumSchema(childSchema)) {
+    enumOption = enumToEnumOptionMapper(
+      currentValue,
+      translateFct,
+      getI18nKeyPrefix(
+        childSchema,
+        findUiControl(uiSchema, childLabelProp),
+        childPath + '.' + childLabelProp
+      )
+    );
+  } else if (isOneOfEnumSchema(childSchema)) {
+    const oneOfArray = childSchema.oneOf as JsonSchema[];
+    const oneOfSchema = oneOfArray.find((e: JsonSchema) =>
+      isEqual(e.const, currentValue)
+    );
+
+    if (oneOfSchema) {
+      enumOption = oneOfToEnumOptionMapper(
+        oneOfSchema,
+        translateFct,
+        getI18nKeyPrefix(
+          oneOfSchema,
+          undefined,
+          childPath + '.' + childLabelProp
+        )
+      );
+    }
+  }
+
+  return enumOption ? enumOption.label : currentValue;
+};

package/src/mappers/util.ts

@@ -0,0 +1,43 @@
+import { JsonSchema, UISchemaElement } from '../models';
+import { JsonFormsState, getAjv } from '../store';
+import { hasEnableRule, isEnabled } from '../util';
+
+/**
+ * Indicates whether the given `uischema` element shall be enabled or disabled.
+ * Checks the global readonly flag, uischema rule, uischema options (including the config),
+ * the schema and the enablement indicator of the parent.
+ */
+export const isInherentlyEnabled = (
+  state: JsonFormsState,
+  ownProps: any,
+  uischema: UISchemaElement,
+  schema: (JsonSchema & { readOnly?: boolean }) | undefined,
+  rootData: any,
+  config: any
+) => {
+  if (state?.jsonforms?.readonly) {
+    return false;
+  }
+  if (uischema && hasEnableRule(uischema)) {
+    return isEnabled(uischema, rootData, ownProps?.path, getAjv(state));
+  }
+  if (typeof uischema?.options?.readonly === 'boolean') {
+    return !uischema.options.readonly;
+  }
+  if (typeof uischema?.options?.readOnly === 'boolean') {
+    return !uischema.options.readOnly;
+  }
+  if (typeof config?.readonly === 'boolean') {
+    return !config.readonly;
+  }
+  if (typeof config?.readOnly === 'boolean') {
+    return !config.readOnly;
+  }
+  if (schema?.readOnly === true) {
+    return false;
+  }
+  if (typeof ownProps?.enabled === 'boolean') {
+    return ownProps.enabled;
+  }
+  return true;
+};

package/src/models/uischema.ts

@@ -284,32 +284,3 @@ export interface Categorization
    */
   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);
-
-export const isControlElement = (
-  uiSchema: UISchemaElement
-): uiSchema is ControlElement => uiSchema.type === 'Control';

package/src/reducers/cells.ts

@@ -23,25 +23,19 @@
   THE SOFTWARE.
 */
 
-import type { RankedTester } from '../testers';
 import {
   ADD_CELL,
   AddCellRendererAction,
   REMOVE_CELL,
   RemoveCellRendererAction,
 } from '../actions';
-import type { Reducer } from '../util';
+import { JsonFormsCellRendererRegistryEntry, Reducer } from '../store';
 
 type ValidCellReducerActions = AddCellRendererAction | RemoveCellRendererAction;
 
 export type JsonFormsCellRendererRegistryState =
   JsonFormsCellRendererRegistryEntry[];
 
-export interface JsonFormsCellRendererRegistryEntry {
-  tester: RankedTester;
-  cell: any;
-}
-
 export const cellReducer: Reducer<
   JsonFormsCellRendererRegistryState,
   ValidCellReducerActions

package/src/reducers/config.ts

@@ -26,7 +26,7 @@
 import merge from 'lodash/merge';
 import { SET_CONFIG, SetConfigAction } from '../actions';
 import { configDefault } from '../configDefault';
-import type { Reducer } from '../util';
+import { Reducer } from '../store';
 
 const applyDefaultConfiguration = (config: any = {}) =>
   merge({}, configDefault, config);