Moved changes to CHANGELOG_v6.md

Author: GlassOfWhiskey

CHANGELOG.md

@@ -16,16 +16,6 @@ should change the heading of the (upcoming) version to include a major version b
 
 -->
 
-# 6.0.0
-
-## @rjsf/core
-
-- Add support for `patternProperties` [#1944](https://github.com/rjsf-team/react-jsonschema-form/issues/1944)
-
-## @rjsf/utils
-
-- Add support for `patternProperties` [#1944](https://github.com/rjsf-team/react-jsonschema-form/issues/1944)
-
 # 5.24.9
 
 ## @rjsf/antd

CHANGELOG_v6.md

@@ -48,6 +48,7 @@ should change the heading of the (upcoming) version to include a major version b
 - BREAKING CHANGE: Moved the addition of `Bootstrap 3` classes from the `SchemaField` to the `WrapIfAdditionalTemplate`, thereby affecting all the other themes, fixing [#2280](https://github.com/rjsf-team/react-jsonschema-form/issues/2280)
 - BREAKING CHANGE: Added `rjsf-` prefix onto the following marker classes used in the fields and templates:
   - `field`, `field-<schema.type>`, `field-error`, `field-hidden`, `field-array`, `field-array-of-<schema.type>`, `field-array-fixed-items`, `array-item`, `config-error`, `array-item-add`, `array-item-copy`, `array-item-move-down`, `array-item-move-up`, `array-item-remove`, `object-property-expand`
+- Added support for `patternProperties` [#1944](https://github.com/rjsf-team/react-jsonschema-form/issues/1944)
 
 ## @rjsf/daisyui
 
@@ -111,6 +112,7 @@ should change the heading of the (upcoming) version to include a major version b
 - BREAKING CHANGE: Removed the deprecated `toErrorList()` function from the `ValidatorType` interface
 - BREAKING CHANGE: Removed the deprecated `RJSF_ADDITONAL_PROPERTIES_FLAG` constant
 - Updated the `WrapIfAdditionalTemplateProps` to include `hideError` and `rawErrors` in support of moving `Bootstrap 3` marker classes out of `SchemaField`
+- Added support for `patternProperties` [#1944](https://github.com/rjsf-team/react-jsonschema-form/issues/1944)
 
 ## @rjsf/validator-ajv6
 
@@ -130,6 +132,7 @@ should change the heading of the (upcoming) version to include a major version b
 - Updated the `playground` to add a `Layout Grid` example and made the selected example now be part of the shared export
 - Replaced Lerna with Nx, updated all lerna commands to use the Nx CLI
 - BREAKING CHANGE: Updated all `peerDependencies` to change minimal `React` support to `>=18`
+- Added documentation and playground example for `patternProperties`
 
 # 6.0.0-alpha.0
 

packages/core/src/components/fields/ObjectField.tsx

@@ -195,13 +195,14 @@ class ObjectField<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends Fo
    * @param schema - The schema element to which the new property is being added
    */
   handleAddClick = (schema: S) => () => {
-    if (!(schema.patternProperties || schema.additionalProperties)) {
+    if (!(schema.additionalProperties || schema.patternProperties)) {
       return;
     }
     const { formData, onChange, registry } = this.props;
     const newFormData = { ...formData } as T;
     const newKey = this.getAvailableKey('newKey', newFormData);
     if (schema.patternProperties) {
+      // Cast this to make the `set` work properly
       set(newFormData as GenericObjectType, newKey, null);
     } else {
       let type: RJSFSchema['type'] = undefined;

packages/utils/src/schema/retrieveSchema.ts

@@ -35,6 +35,7 @@ import {
 } from '../types';
 import getFirstMatchingOption from './getFirstMatchingOption';
 import deepEquals from '../deepEquals';
+import isEmpty from 'lodash/isEmpty';
 
 /** 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
@@ -187,6 +188,27 @@ export function getAllPermutationsOfXxxOf<S extends StrictRJSFSchema = RJSFSchem
   return allPermutations;
 }
 
+/** Returns the subset of 'patternProperties' specifications that match the given 'key'
+ *
+ * @param schema - The schema whose 'patternProperties' are to be filtered
+ * @param key - The key to match against the 'patternProperties' specifications
+ * @returns - The subset of 'patternProperties' specifications that match the given 'key'
+ */
+export function getMatchingPatternProperties<S extends StrictRJSFSchema = RJSFSchema>(
+  schema: S,
+  key: string,
+): S['patternProperties'] {
+  return Object.keys(schema.patternProperties!)
+    .filter((pattern) => RegExp(pattern).test(key))
+    .reduce(
+      (obj, pattern) => {
+        obj[pattern] = schema.patternProperties![pattern];
+        return obj;
+      },
+      {} as S['patternProperties'],
+    );
+}
+
 /** Resolves references and dependencies within a schema and its 'allOf' children. Passes the `expandAllBranches` flag
  * down to the `retrieveSchemaInternal()`, `resolveReference()` and `resolveDependencies()` helper calls. If
  * `expandAllBranches` is true, then all possible dependencies and/or allOf branches are returned.
@@ -397,16 +419,11 @@ export function stubExistingAdditionalProperties<
       return;
     }
     if (PATTERN_PROPERTIES_KEY in schema) {
-      const patternProperties = Object.keys(schema.patternProperties!)
-        .filter((pattern) => RegExp(pattern).test(key))
-        .reduce((obj, pattern) => {
-          obj[pattern] = schema.patternProperties![pattern];
-          return obj;
-        }, {} as NonNullable<S['patternProperties']>);
-      if (Object.keys(patternProperties).length > 0) {
+      const matchingProperties = getMatchingPatternProperties(schema, key);
+      if (!isEmpty(matchingProperties)) {
         schema.properties[key] = retrieveSchema<T, S, F>(
           validator,
-          { allOf: Object.values(patternProperties) } as S,
+          { allOf: Object.values(matchingProperties) } as S,
           rootSchema,
           formData as T,
           experimental_customMergeAllOf,
@@ -424,7 +441,7 @@ export function stubExistingAdditionalProperties<
             { $ref: get(schema.additionalProperties, [REF_KEY]) } as S,
             rootSchema,
             formData as T,
-            experimental_customMergeAllOf
+            experimental_customMergeAllOf,
           );
         } else if ('type' in schema.additionalProperties!) {
           additionalProperties = { ...schema.additionalProperties };
@@ -545,27 +562,22 @@ export function retrieveSchemaInternal<
     if (PROPERTIES_KEY in resolvedSchema && PATTERN_PROPERTIES_KEY in resolvedSchema) {
       resolvedSchema = Object.keys(resolvedSchema.properties!).reduce(
         (schema, key) => {
-          const patternProperties = Object.keys(schema.patternProperties!)
-            .filter((pattern) => RegExp(pattern).test(key))
-            .reduce((obj, pattern) => {
-              obj[pattern] = schema.patternProperties![pattern];
-              return obj;
-            }, {} as NonNullable<S['patternProperties']>);
-          if (Object.keys(patternProperties).length > 0) {
+          const matchingProperties = getMatchingPatternProperties(schema, key);
+          if (!isEmpty(matchingProperties)) {
             schema.properties[key] = retrieveSchema<T, S, F>(
               validator,
-              { allOf: [schema.properties[key], ...Object.values(patternProperties)] } as S,
+              { allOf: [schema.properties[key], ...Object.values(matchingProperties)] } as S,
               rootSchema,
               rawFormData as T,
-              experimental_customMergeAllOf
+              experimental_customMergeAllOf,
             );
           }
           return schema;
         },
         {
           ...resolvedSchema,
           properties: { ...resolvedSchema.properties },
-        }
+        },
       );
     }
     const hasAdditionalProperties =