@rjsf/utils 6.5.2 → 6.6.0

package/src/types.ts

@@ -11,6 +11,7 @@ import type {
 import { JSONSchema7 } from 'json-schema';
 
 import { TranslatableString } from './enums';
+import './jsonSchemaAugmentation';
 
 /** The representation of any generic object type, usually used as an intersection on other types to make them more
  * flexible in the properties they support (i.e. anything else)
@@ -185,6 +186,9 @@ export type InputPropsType = {
  */
 export type FieldPathList = (string | number)[];
 
+/** Dot string or segment list for `getFromSchema` / `findFieldInSchema` (same segment rules as {@link FieldPathList}). */
+export type SchemaFieldPath = string | FieldPathList;
+
 /** Type describing an id and path used for a field */
 export type FieldPathId = {
   /** The id for a field */
@@ -201,7 +205,9 @@ export type FieldPath = {
   $name: string;
 };
 
-/** Type describing a recursive structure of `FieldPath`s for an object with a non-empty set of keys */
+/** Type describing a recursive structure of `FieldPath`s for an object with a non-empty set of keys
+ * @deprecated - To be removed as an exported `@rjsf/utils` type in a future release
+ */
 export type PathSchema<T = any> =
   T extends Array<infer U>
     ? FieldPath & {
@@ -447,6 +453,12 @@ export type GlobalUISchemaOptions = GenericObjectType & {
    *  only affects the DOM-level encoding.
    */
   optionValueFormat?: OptionValueFormat;
+  /** Controls how a deprecated property is rendered.
+   * - `hide`: The field is completely hidden (via the `hidden` prop passed to FieldTemplate).
+   * - `disable`: The field is rendered but disabled.
+   * - `label` (default): The field is rendered with "(deprecated)" appended to its label.
+   */
+  deprecatedHandling?: 'hide' | 'disable' | 'label';
 };
 
 /** The set of options from the `Form` that will be available on the `Registry` for use in everywhere the `registry` is
@@ -1328,7 +1340,7 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
    * @returns - An object that contains the field and its required state. If no field can be found then
    *            `{ field: undefined, isRequired: undefined }` is returned.
    */
-  findFieldInSchema(schema: S, path: string | string[], formData?: T): FoundFieldType<S>;
+  findFieldInSchema(schema: S, path: SchemaFieldPath, formData?: T): FoundFieldType<S>;
   /** Finds the oneOf option inside the `schema['any/oneOf']` list which has the `properties[selectorField].default` that
    * matches the `formData[selectorField]` value. For the purposes of this function, `selectorField` is either
    * `schema.discriminator.propertyName` or `fallbackField`.
@@ -1403,9 +1415,9 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
    * @param defaultValue - The value to return if a value is not found for the `pathList` path
    * @returns - The internal schema from the `schema` for the given `path` or the `defaultValue` if not found
    */
-  getFromSchema(schema: S, path: string | string[], defaultValue: T): T;
-  getFromSchema(schema: S, path: string | string[], defaultValue: S): S;
-  getFromSchema(schema: S, path: string | string[], defaultValue: T | S): S | T;
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: T): T;
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: S): S;
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: T | S): S | T;
   /** Checks to see if the `schema` and `uiSchema` combination represents an array of files
    *
    * @param schema - The schema for which check for array of files flag is desired
@@ -1463,6 +1475,7 @@ export interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchem
    * @param [name] - The base name for the schema
    * @param [formData] - The current formData, if any, onto which to provide any missing defaults
    * @returns - The `PathSchema` object for the `schema`
+   * @deprecated - To be removed as an exported `@rjsf/utils` function in a future release
    */
   toPathSchema(schema: S, name?: string, formData?: T): PathSchema<T>;
 }

package/src/useFileWidgetProps.ts

@@ -20,7 +20,7 @@ export interface UseFileWidgetPropsResult {
   /** The list of FileInfoType contained within the FileWidget */
   filesInfo: FileInfoType[];
   /** The callback handler to pass to the onChange of the input */
-  handleChange: (files: FileList) => void;
+  handleChange: (files: FileList) => void | Promise<void>;
   /** The callback handler to pass in order to delete a file */
   handleRemove: (index: number) => void;
 }
@@ -129,15 +129,14 @@ export default function useFileWidgetProps(
   );
 
   const handleChange = useCallback(
-    (files: FileList) => {
-      processFiles(files).then((filesInfoEvent) => {
-        const newValue = filesInfoEvent.map((fileInfo) => fileInfo.dataURL || null);
-        if (multiple) {
-          onChange(values.concat(...newValue));
-        } else {
-          onChange(newValue[0]);
-        }
-      });
+    async (files: FileList) => {
+      const filesInfoEvent = await processFiles(files);
+      const newValue = filesInfoEvent.map((fileInfo) => fileInfo.dataURL || null);
+      if (multiple) {
+        onChange(values.concat(...newValue));
+      } else {
+        onChange(newValue[0]);
+      }
     },
     [values, multiple, onChange],
   );

package/src/withIdRefPrefix.ts

@@ -1,6 +1,7 @@
+import isObject from 'lodash/isObject';
+
 import { REF_KEY, ROOT_SCHEMA_PREFIX } from './constants';
 import { RJSFSchema, StrictRJSFSchema } from './types';
-import isObject from 'lodash/isObject';
 
 /** Takes a `node` object and transforms any contained `$ref` node variables with a prefix, recursively calling
  * `withIdRefPrefix` for any other elements.