@rjsf/utils 6.5.2 → 6.5.3

package/lib/types.d.ts

@@ -1,6 +1,7 @@
 import type { ButtonHTMLAttributes, ChangeEvent, ComponentType, FocusEvent, HTMLAttributes, ReactElement, ReactNode, StyleHTMLAttributes } from 'react';
 import { JSONSchema7 } from 'json-schema';
 import { TranslatableString } from './enums.js';
+import './jsonSchemaAugmentation.js';
 /** 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)
  */
@@ -156,6 +157,8 @@ export type InputPropsType = {
  * `['baz', 1]` represents the second element in the list `baz` of the schema
  */
 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 */
@@ -383,6 +386,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
  * available.
@@ -1073,7 +1082,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`.
@@ -1138,9 +1147,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

package/lib/types.js

@@ -1,2 +1,2 @@
-export {};
+import './jsonSchemaAugmentation.js';
 //# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,OAAO,0BAA0B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rjsf/utils",
-  "version": "6.5.2",
+  "version": "6.5.3",
   "main": "dist/index.js",
   "module": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -67,7 +67,7 @@
   "dependencies": {
     "@x0k/json-schema-merge": "^1.0.3",
     "fast-equals": "^6.0.0",
-    "fast-uri": "^3.1.0",
+    "fast-uri": "^3.1.2",
     "jsonpointer": "^5.0.1",
     "lodash": "^4.18.1",
     "lodash-es": "^4.18.1",

package/src/createSchemaUtils.ts

@@ -7,6 +7,7 @@ import {
   GlobalUISchemaOptions,
   PathSchema,
   RJSFSchema,
+  SchemaFieldPath,
   SchemaUtilsType,
   StrictRJSFSchema,
   UiSchema,
@@ -127,7 +128,7 @@ class SchemaUtils<
    * @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> {
     return findFieldInSchema(
       this.validator,
       this.rootSchema,
@@ -259,9 +260,9 @@ class SchemaUtils<
    * @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): T | S {
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: T): T;
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: S): S;
+  getFromSchema(schema: S, path: SchemaFieldPath, defaultValue: T | S): T | S {
     return getFromSchema<T, S, F>(
       this.validator,
       this.rootSchema,

package/src/enums.ts

@@ -68,6 +68,8 @@ export enum TranslatableString {
   TitleOptionPrefix = '%1 option %2',
   /** Key label, where %1 will be replaced by the label as provided by WrapIfAdditionalTemplate */
   KeyLabel = '%1 Key',
+  /** Deprecated label, where %1 will be replaced by the label as provided by SchemaField */
+  DeprecatedLabel = '%1 (deprecated)',
   // Strings with replaceable parameters AND/OR that support markdown and html
   /** Invalid object field configuration as provided by the ObjectField.
    * NOTE: Use markdown notation rather than html tags.

package/src/jsonSchemaAugmentation.ts

@@ -0,0 +1,21 @@
+import type { JSONSchema7 } from 'json-schema';
+
+/**
+ * This file is used to augment the `json-schema` module with the `deprecated` keyword.
+ *
+ * It is a dedicated file because `json-schema` is a type-only package. Standard augmentation
+ * using `import 'json-schema'` in a file with other imports can cause module resolution
+ * errors in certain environments (like Jest). Using `import type` in this dedicated file
+ * ensures the augmentation is correctly applied by the TypeScript compiler without
+ * confusing runtime module resolvers.
+ */
+declare module 'json-schema' {
+  export interface JSONSchema7 {
+    /** The deprecated keyword is a boolean that indicates that the instance value the keyword applies to should not be
+     * used and may be removed in the future.
+     */
+    deprecated?: boolean;
+  }
+}
+
+export type { JSONSchema7 };

package/src/mergeDefaultsWithFormData.ts

@@ -68,7 +68,8 @@ export default function mergeDefaultsWithFormData<T = any>(
       const keyExistsInDefaults = isObject(defaults) && key in (defaults as GenericObjectType);
       const keyExistsInFormData = key in (formData as GenericObjectType);
       const keyDefault = get(defaults, key) ?? {};
-      const defaultValueIsNestedObject = keyExistsInDefaults && Object.entries(keyDefault).some(([, v]) => isObject(v));
+      const defaultValueIsNestedObject =
+        keyExistsInDefaults && isObject(keyDefault) && Object.values(keyDefault).some((v) => isObject(v));
 
       const keyDefaultIsObject = keyExistsInDefaults && isObject(get(defaults, key));
       const keyHasFormDataObject = keyExistsInFormData && isObject(keyValue);

package/src/schema/findFieldInSchema.ts

@@ -9,6 +9,7 @@ import {
   FormContextType,
   FoundFieldType,
   RJSFSchema,
+  SchemaFieldPath,
   StrictRJSFSchema,
   ValidatorType,
 } from '../types';
@@ -37,7 +38,7 @@ export default function findFieldInSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   formData: T = {} as T,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): FoundFieldType<S> {
@@ -46,6 +47,7 @@ export default function findFieldInSchema<
 
   // store the desired field into a variable and removing it from the `pathList`
   const fieldName = pathList.pop()!;
+  const fieldNameKey = String(fieldName);
 
   if (pathList.length) {
     // drilling into the schema for each sub-path and taking into account of the any/oneOfs
@@ -64,7 +66,7 @@ export default function findFieldInSchema<
           validator,
           rootSchema,
           parentField,
-          fieldName,
+          fieldNameKey,
           ONE_OF_KEY,
           get(formData, subPath),
           experimental_customMergeAllOf,
@@ -75,7 +77,7 @@ export default function findFieldInSchema<
           validator,
           rootSchema,
           parentField,
-          fieldName,
+          fieldNameKey,
           ANY_OF_KEY,
           get(formData, subPath),
           experimental_customMergeAllOf,
@@ -90,7 +92,7 @@ export default function findFieldInSchema<
       validator,
       rootSchema,
       parentField,
-      fieldName,
+      fieldNameKey,
       ONE_OF_KEY,
       formData,
       experimental_customMergeAllOf,
@@ -101,7 +103,7 @@ export default function findFieldInSchema<
       validator,
       rootSchema,
       parentField,
-      fieldName,
+      fieldNameKey,
       ANY_OF_KEY,
       formData,
       experimental_customMergeAllOf,
@@ -131,7 +133,7 @@ export default function findFieldInSchema<
   );
   let isRequired: boolean | undefined;
   if (field && Array.isArray(requiredArray)) {
-    isRequired = requiredArray.includes(fieldName);
+    isRequired = requiredArray.includes(fieldNameKey);
   }
 
   return { field, isRequired };

package/src/schema/getFromSchema.ts

@@ -3,7 +3,14 @@ import has from 'lodash/has';
 import isEmpty from 'lodash/isEmpty';
 
 import retrieveSchema from './retrieveSchema';
-import { Experimental_CustomMergeAllOf, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+import {
+  Experimental_CustomMergeAllOf,
+  FormContextType,
+  RJSFSchema,
+  SchemaFieldPath,
+  StrictRJSFSchema,
+  ValidatorType,
+} from '../types';
 import { REF_KEY } from '../constants';
 
 /** Internal helper function that acts like lodash's `get` but additionally retrieves `$ref`s as needed to get the path
@@ -20,7 +27,7 @@ function getFromSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T | S | undefined {
   let fieldSchema = schema;
@@ -30,9 +37,9 @@ function getFromSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
   if (isEmpty(path)) {
     return fieldSchema;
   }
-  const pathList = Array.isArray(path) ? path : path.split('.');
+  const pathList = Array.isArray(path) ? [...path] : path.split('.');
   const [part, ...nestedPath] = pathList;
-  if (part && has(fieldSchema, part)) {
+  if (part !== undefined && part !== '' && has(fieldSchema, part)) {
     fieldSchema = get(fieldSchema, part) as S;
     return getFromSchemaInternal<T, S, F>(
       validator,
@@ -64,7 +71,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: T,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T;
@@ -76,7 +83,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: S,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): S;
@@ -88,7 +95,7 @@ export default function getFromSchema<
   validator: ValidatorType<T, S, F>,
   rootSchema: S,
   schema: S,
-  path: string | string[],
+  path: SchemaFieldPath,
   defaultValue: T | S,
   experimental_customMergeAllOf?: Experimental_CustomMergeAllOf<S>,
 ): T | S {

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 */
@@ -447,6 +451,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 +1338,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 +1413,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