@rjsf/utils 6.5.3 → 6.6.0

package/src/schema/retrieveSchema.ts

@@ -1,13 +1,11 @@
+import flattenDeep from 'lodash/flattenDeep';
 import get from 'lodash/get';
+import isEmpty from 'lodash/isEmpty';
+import merge from 'lodash/merge';
 import set from 'lodash/set';
 import times from 'lodash/times';
 import transform from 'lodash/transform';
-import merge from 'lodash/merge';
-import flattenDeep from 'lodash/flattenDeep';
 import uniq from 'lodash/uniq';
-import isEmpty from 'lodash/isEmpty';
-import { createComparator, createMerger, createShallowAllOfMerge } from '@x0k/json-schema-merge';
-import { createDeduplicator, createIntersector } from '@x0k/json-schema-merge/lib/array';
 
 import {
   ADDITIONAL_PROPERTIES_KEY,
@@ -24,6 +22,7 @@ import {
   REF_KEY,
   RJSF_REF_KEY,
 } from '../constants';
+import deepEquals from '../deepEquals';
 import findSchemaDefinition, { splitKeyElementFromObject } from '../findSchemaDefinition';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 import guessType from '../guessType';
@@ -38,7 +37,7 @@ import {
   ValidatorType,
 } from '../types';
 import getFirstMatchingOption from './getFirstMatchingOption';
-import deepEquals from '../deepEquals';
+import shallowAllOfMerge from './shallowAllOfMerge';
 
 /** Retrieves an expanded schema that has had all of its conditions, additional properties, references and dependencies
  * resolved and merged into the `schema` given a `validator`, `rootSchema` and `rawFormData` that is used to do the
@@ -514,15 +513,6 @@ export function stubExistingAdditionalProperties<
   return schema;
 }
 
-// Set up @x0k/json-schema-merge utilities
-const { compareSchemaDefinitions, compareSchemaValues } = createComparator();
-const { mergeArrayOfSchemaDefinitions } = createMerger({
-  intersectJson: createIntersector(compareSchemaValues),
-  deduplicateJsonSchemaDef: createDeduplicator(compareSchemaDefinitions),
-});
-
-const shallowAllOfMerge = createShallowAllOfMerge(mergeArrayOfSchemaDefinitions);
-
 /**
  * Internal helper that merges allOf schemas using @x0k/json-schema-merge's shallow allOf merge
  * @param schema - The schema containing an `allOf` keyword
@@ -694,6 +684,14 @@ export function resolveAnyOrOneOfSchemas<
     // Call this to trigger the set of isValid() calls that the schema parser will need
     const option = getFirstMatchingOption<T, S, F>(validator, formData, anyOrOneOf, rootSchema, discriminator);
     if (expandAllBranches) {
+      // Also trigger isValid() for the relaxed variants so that precompiled validators capture their hashes.
+      // omitExtraData's handleOneOf relaxes additionalProperties:false → true before scoring; those mutated
+      // schemas must be present in a precompiled validator's compiled set or isValid() will throw at runtime.
+      // Using getFirstMatchingOption (rather than calling isValid directly) ensures that the augmented forms
+      // of each option (as constructed internally by getFirstMatchingOption for options with properties) are
+      // also captured. The return value is discarded — the call is purely for ParserValidator's side effect.
+      const relaxed = relaxOptionsForScoring<S>(anyOrOneOf, false, rootSchema);
+      getFirstMatchingOption<T, S, F>(validator, formData, relaxed, rootSchema, discriminator);
       return anyOrOneOf.map((item) => mergeSchemas(remaining, item) as S);
     }
     schema = mergeSchemas(remaining, anyOrOneOf[option]) as S;
@@ -701,6 +699,34 @@ export function resolveAnyOrOneOfSchemas<
   return [schema];
 }
 
+/** Normalises a list of `oneOf`/`anyOf` options for use in option-scoring only (not for filtering).
+ * Boolean schemas are converted to their object equivalents (`true` → `{}`, `false` → `{not:{}}`).
+ * When `resolveRefs` is `true`, each object option is first passed through `resolveAllReferences`
+ * so that `$ref`-based options expose their `additionalProperties` constraint before relaxation.
+ * Any option whose `additionalProperties` is `false` is widened to `true` so that
+ * `getClosestMatchingOption` / `validator.isValid()` does not produce false negatives when the
+ * form data contains keys not listed in `properties`.
+ *
+ * @param options - The raw `oneOf`/`anyOf` array, which may contain boolean schemas
+ * @param [resolveRefs=false] - When `true`, resolve `$ref`s in each option before relaxing; pass
+ *   `rootSchema` as well. Set `false` (default) when refs are already resolved at the call site.
+ * @param [rootSchema] - Required when `resolveRefs` is `true`; the root schema used to look up `$ref`s
+ * @returns - A new array of plain schema objects with `additionalProperties` relaxed where needed
+ */
+export function relaxOptionsForScoring<S extends StrictRJSFSchema = RJSFSchema>(
+  options: Array<S | boolean>,
+  resolveRefs = false,
+  rootSchema?: S,
+): S[] {
+  return options.map((d) => {
+    if (!isObject(d)) {
+      return (d ? {} : { not: {} }) as S;
+    }
+    const schema = resolveRefs && rootSchema ? resolveAllReferences<S>(d as S, rootSchema, []) : (d as S);
+    return schema.additionalProperties === false ? { ...schema, additionalProperties: true } : schema;
+  });
+}
+
 /** Resolves dependencies within a schema and its 'anyOf/oneOf' children. Passes the `expandAllBranches` flag down to
  * the `resolveAnyOrOneOfSchema()` and `processDependencies()` helper calls.
  *

package/src/schema/sanitizeDataForNewSchema.ts

@@ -1,6 +1,7 @@
 import get from 'lodash/get';
 import has from 'lodash/has';
 
+import { PROPERTIES_KEY, REF_KEY } from '../constants';
 import {
   Experimental_CustomMergeAllOf,
   FormContextType,
@@ -9,7 +10,6 @@ import {
   StrictRJSFSchema,
   ValidatorType,
 } from '../types';
-import { PROPERTIES_KEY, REF_KEY } from '../constants';
 import retrieveSchema from './retrieveSchema';
 
 const NO_VALUE = Symbol('no Value');

package/src/schema/shallowAllOfMerge.ts

@@ -0,0 +1,19 @@
+import { createComparator, createMerger, createShallowAllOfMerge } from '@x0k/json-schema-merge';
+import { createDeduplicator, createIntersector } from '@x0k/json-schema-merge/lib/array';
+
+const { compareSchemaDefinitions, compareSchemaValues } = createComparator();
+const { mergeArrayOfSchemaDefinitions } = createMerger({
+  intersectJson: createIntersector(compareSchemaValues),
+  deduplicateJsonSchemaDef: createDeduplicator(compareSchemaDefinitions),
+});
+
+/** Shared `@x0k/json-schema-merge` shallow-allOf merge function used by `retrieveSchema` and
+ * `omitExtraData`. Constructed once from a single comparator/merger/intersector/deduplicator
+ * pipeline so both consumers share the same configuration without duplicating setup code.
+ *
+ * Usage: pass a schema that contains an `allOf` keyword and receive the merged result.
+ *
+ * @example
+ * const merged = shallowAllOfMerge(schema); // schema.allOf is merged into the parent schema
+ */
+export default createShallowAllOfMerge(mergeArrayOfSchemaDefinitions);

package/src/schema/toPathSchema.ts

@@ -15,6 +15,7 @@ import {
   REF_KEY,
   RJSF_ADDITIONAL_PROPERTIES_FLAG,
 } from '../constants';
+import deepEquals from '../deepEquals';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
 import {
   Experimental_CustomMergeAllOf,
@@ -27,7 +28,6 @@ import {
 } from '../types';
 import getClosestMatchingOption from './getClosestMatchingOption';
 import retrieveSchema from './retrieveSchema';
-import deepEquals from '../deepEquals';
 
 /** An internal helper that generates an `PathSchema` object for the `schema`, recursively with protection against
  * infinite recursion
@@ -188,6 +188,7 @@ function toPathSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
  * @param [formData] - The current formData, if any, to assist retrieving a schema
  * @param [experimental_customMergeAllOf] - Optional function that allows for custom merging of `allOf` schemas
  * @returns - The `PathSchema` object for the `schema`
+ * @deprecated - To be removed as an exported `@rjsf/utils` function in a future release
  */
 export default function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(
   validator: ValidatorType<T, S, F>,

package/src/shouldRenderOptionalField.ts

@@ -1,11 +1,11 @@
 import isObject from 'lodash/isObject';
 import uniq from 'lodash/uniq';
 
-import { FormContextType, Registry, RJSFSchema, StrictRJSFSchema, UiSchema } from './types';
+import { ANY_OF_KEY, ONE_OF_KEY } from './constants';
 import getSchemaType from './getSchemaType';
 import getUiOptions from './getUiOptions';
 import isRootSchema from './isRootSchema';
-import { ANY_OF_KEY, ONE_OF_KEY } from './constants';
+import { FormContextType, Registry, RJSFSchema, StrictRJSFSchema, UiSchema } from './types';
 
 /** Returns the unique list of schema types for all of the options in a anyOf/oneOf
  *

package/src/toErrorSchema.ts

@@ -1,7 +1,7 @@
 import toPath from 'lodash/toPath';
 
-import { ErrorSchema, RJSFValidationError } from './types';
 import ErrorSchemaBuilder from './ErrorSchemaBuilder';
+import { ErrorSchema, RJSFValidationError } from './types';
 
 /** Transforms a rjsf validation errors list:
  * [

package/src/tsconfig.json

@@ -4,7 +4,6 @@
   "compilerOptions": {
     "rootDir": "./",
     "outDir": "../lib",
-    "baseUrl": "../",
     "jsx": "react-jsx"
   }
 }

package/src/types.ts

@@ -205,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 & {
@@ -1473,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.