@jsonforms/core 3.4.1 → 3.5.0-beta.1

package/lib/mappers/renderer.d.ts

@@ -32,6 +32,12 @@ export declare const showAsRequired: (required: boolean, hideRequiredAsterisk: b
  * @returns {any}
  */
 export declare const createDefaultValue: (schema: JsonSchema, rootSchema: JsonSchema) => any;
+/**
+ * Create a default value based on the given schema.
+ * @param schema the schema for which to create a default value.
+ * @returns the default value to use, undefined if none was found
+ */
+export declare const doCreateDefaultValue: (schema: JsonSchema, rootSchema: JsonSchema) => any;
 /**
  * Returns the default value defined in the given schema.
  * @param schema the schema for which to create a default value.
@@ -310,6 +316,7 @@ export interface ControlWithDetailProps extends StatePropsOfControlWithDetail, D
  * State-based props of a table control.
  */
 export interface StatePropsOfArrayControl extends StatePropsOfControlWithDetail {
+    arraySchema: JsonSchema;
     childErrors?: ErrorObject[];
 }
 /**
@@ -374,7 +381,7 @@ export declare const controlDefaultProps: {
     visible: boolean;
     enabled: boolean;
     path: string;
-    direction: 'row' | 'column';
+    direction: "row" | "column";
 };
 export interface StatePropsOfCombinator extends StatePropsOfControl {
     rootSchema: JsonSchema;
@@ -398,6 +405,10 @@ export declare const mapStateToAnyOfProps: (state: JsonFormsState, ownProps: Own
 export declare const mapStateToOneOfProps: (state: JsonFormsState, ownProps: OwnPropsOfControl) => StatePropsOfCombinator;
 export interface StatePropsOfArrayLayout extends StatePropsOfControlWithDetail {
     data: number;
+    arraySchema: JsonSchema;
+    /**
+     * @deprecated Use `arraySchema.minItems` instead.
+     */
     minItems?: number;
     disableRemove?: boolean;
     disableAdd?: boolean;

package/lib/util/uischema.d.ts

@@ -16,6 +16,6 @@ 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 isLabelable: (obj: unknown) => obj is Labelable;
 export declare const isLabeled: <T = never>(obj: unknown) => obj is Labeled<T>;
 export declare const isControlElement: (uiSchema: UISchemaElement) => uiSchema is ControlElement;

package/lib/util/util.d.ts

@@ -25,7 +25,7 @@ import type { JsonSchema, Scoped, UISchemaElement } from '../models';
  * // returns '2023-11-09T14:22:54.131Z'
  * convertDateToString(new Date('2023-11-09T14:22:54.131Z'));
  */
-export declare const convertDateToString: (date: Date, format?: 'date' | 'time' | 'date-time') => string;
+export declare const convertDateToString: (date: Date, format?: "date" | "time" | "date-time") => string;
 /**
  * Escape the given string such that it can be used as a class name,
  * i.e. hashes and slashes will be replaced.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonforms/core",
-  "version": "3.4.1",
+  "version": "3.5.0-beta.1",
   "description": "Core module of JSON Forms",
   "repository": "https://github.com/eclipsesource/jsonforms",
   "bugs": "https://github.com/eclipsesource/jsonforms/issues",
@@ -86,7 +86,7 @@
     "ts-node": "^10.4.0",
     "tslib": "^2.5.0",
     "typedoc": "~0.25.3",
-    "typescript": "~5.2.2"
+    "typescript": "~5.5.0"
   },
   "scripts": {
     "build": "rollup -c rollup.config.js",

package/src/mappers/renderer.ts

@@ -170,7 +170,25 @@ export const createDefaultValue = (
   schema: JsonSchema,
   rootSchema: JsonSchema
 ) => {
-  const resolvedSchema = Resolve.schema(schema, schema.$ref, rootSchema);
+  const defaultValue = doCreateDefaultValue(schema, rootSchema);
+
+  // preserve the backward compatibility where it is returning an empty object if we can't determine the default value
+  return defaultValue === undefined ? {} : defaultValue;
+};
+
+/**
+ * Create a default value based on the given schema.
+ * @param schema the schema for which to create a default value.
+ * @returns the default value to use, undefined if none was found
+ */
+export const doCreateDefaultValue = (
+  schema: JsonSchema,
+  rootSchema: JsonSchema
+) => {
+  const resolvedSchema =
+    typeof schema.$ref === 'string'
+      ? Resolve.schema(rootSchema, schema.$ref, rootSchema)
+      : schema;
   if (resolvedSchema.default !== undefined) {
     return extractDefaults(resolvedSchema, rootSchema);
   }
@@ -183,22 +201,56 @@ export const createDefaultValue = (
       return convertDateToString(new Date(), resolvedSchema.format);
     }
     return '';
-  } else if (
-    hasType(resolvedSchema, 'integer') ||
-    hasType(resolvedSchema, 'number')
-  ) {
+  }
+  if (hasType(resolvedSchema, 'integer') || hasType(resolvedSchema, 'number')) {
     return 0;
-  } else if (hasType(resolvedSchema, 'boolean')) {
+  }
+  if (hasType(resolvedSchema, 'boolean')) {
     return false;
-  } else if (hasType(resolvedSchema, 'array')) {
+  }
+  if (hasType(resolvedSchema, 'array')) {
     return [];
-  } else if (hasType(resolvedSchema, 'object')) {
+  }
+  if (hasType(resolvedSchema, 'object')) {
     return extractDefaults(resolvedSchema, rootSchema);
-  } else if (hasType(resolvedSchema, 'null')) {
+  }
+  if (hasType(resolvedSchema, 'null')) {
     return null;
-  } else {
-    return {};
   }
+
+  const combinators: CombinatorKeyword[] = ['oneOf', 'anyOf', 'allOf'];
+  for (const combinator of combinators) {
+    if (schema[combinator] && Array.isArray(schema[combinator])) {
+      const combinatorDefault = createDefaultValueForCombinatorSchema(
+        schema[combinator],
+        rootSchema
+      );
+      if (combinatorDefault !== undefined) {
+        return combinatorDefault;
+      }
+    }
+  }
+
+  // no default value found
+  return undefined;
+};
+
+const createDefaultValueForCombinatorSchema = (
+  combinatorSchemas: JsonSchema[],
+  rootSchema: JsonSchema
+): any => {
+  if (combinatorSchemas.length > 0) {
+    for (const combinatorSchema of combinatorSchemas) {
+      const result = doCreateDefaultValue(combinatorSchema, rootSchema);
+      if (result !== undefined) {
+        // return the first one with type information
+        return result;
+      }
+    }
+  }
+
+  // no default value found
+  return undefined;
 };
 
 /**
@@ -214,10 +266,26 @@ export const extractDefaults = (schema: JsonSchema, rootSchema: JsonSchema) => {
       const resolvedProperty = property.$ref
         ? Resolve.schema(rootSchema, property.$ref, rootSchema)
         : property;
-      if (resolvedProperty.default !== undefined) {
+      if (resolvedProperty && resolvedProperty.default !== undefined) {
         result[key] = cloneDeep(resolvedProperty.default);
       }
     }
+    // there could be more properties in allOf schemas
+    if (schema.allOf && Array.isArray(schema.allOf)) {
+      schema.allOf.forEach((allOfSchema) => {
+        if (allOfSchema && allOfSchema.properties) {
+          for (const key in allOfSchema.properties) {
+            const property = allOfSchema.properties[key];
+            const resolvedProperty = property.$ref
+              ? Resolve.schema(rootSchema, property.$ref, rootSchema)
+              : property;
+            if (resolvedProperty && resolvedProperty.default !== undefined) {
+              result[key] = cloneDeep(resolvedProperty.default);
+            }
+          }
+        }
+      });
+    }
     return result;
   }
   return cloneDeep(schema.default);
@@ -785,6 +853,7 @@ export interface ControlWithDetailProps
  */
 export interface StatePropsOfArrayControl
   extends StatePropsOfControlWithDetail {
+  arraySchema: JsonSchema;
   childErrors?: ErrorObject[];
 }
 
@@ -811,6 +880,7 @@ export const mapStateToArrayControlProps = (
     path,
     uischema,
     schema: resolvedSchema,
+    arraySchema: schema,
     childErrors,
     renderers: ownProps.renderers || getRenderers(state),
     cells: ownProps.cells || getCells(state),
@@ -1139,6 +1209,10 @@ export const mapStateToOneOfProps = (
 
 export interface StatePropsOfArrayLayout extends StatePropsOfControlWithDetail {
   data: number;
+  arraySchema: JsonSchema;
+  /**
+   * @deprecated Use `arraySchema.minItems` instead.
+   */
   minItems?: number;
   disableRemove?: boolean;
   disableAdd?: boolean;
@@ -1179,6 +1253,7 @@ export const mapStateToArrayLayoutProps = (
     path,
     uischema,
     schema: resolvedSchema,
+    arraySchema: schema,
     data: props.data ? props.data.length : 0,
     errors: allErrors,
     minItems: schema.minItems,

package/src/util/resolvers.ts

@@ -127,7 +127,8 @@ const resolveSchemaWithSegments = (
     return undefined;
   }
 
-  if (schema.$ref) {
+  // use typeof because schema can by of any type - check singleSegmentResolveSchema below
+  if (typeof schema.$ref === 'string') {
     schema = resolveSchema(rootSchema, schema.$ref, rootSchema);
   }