Added support for patternProperties
#4582
Conversation
|
@GlassOfWhiskey thanks for the bug fix. With v5 being locked down for anything but emergency fixes, Can you rebase this onto the |
GlassOfWhiskey
force-pushed
the
main
branch
5 times, most recently
from
60b6b54 to
b2bcf10
Compare
|
Hi @heath-freenome, I think I did what requested. I also added an example in the playground package. |
GlassOfWhiskey
force-pushed
the
main
branch
2 times, most recently
from
63f6e99 to
2982d9f
Compare
|
@GlassOfWhiskey can you run |
Sorry I didn't notice that lint dependencies were changed in v6. I reran the formatter, but I only pushed the changes to the files I actually modified. There were other changes in the components package, but I left them for another PR if needed. |
I believe that my PR #4583 gets those |
| }, | ||
| {} as NonNullable<S['patternProperties']>, | ||
| ); | ||
| if (Object.keys(patternProperties).length > 0) { |
There was a problem hiding this comment.
Does !isEmpty(patternProperties) work?
| }, | ||
| {} as NonNullable<S['patternProperties']>, | ||
| ); | ||
| if (Object.keys(patternProperties).length > 0) { |
There was a problem hiding this comment.
Does !isEmpty(patternProperties) work?
| 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']>, | ||
| ); |
There was a problem hiding this comment.
This looks like a duplicate of the code at lines 551-559, consider drying things up with a helper method
| 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']>, | ||
| ); |
There was a problem hiding this comment.
This looks like a duplicate of the code at lines 400-408, consider drying things up with a helper method
| @@ -195,36 +195,39 @@ 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.additionalProperties) { | |||
| if (!(schema.patternProperties || schema.additionalProperties)) { | |||
There was a problem hiding this comment.
This matches the order in code down in utils
| if (!(schema.patternProperties || schema.additionalProperties)) { | |
| if (!(schema.additionalProperties || schema.patternProperties)) { |
Reasons for making this change
Fixes #1944 (which has been closed without being resolved) by extending RJSF support to the
patternPropertiesJSONSchema directive. In detail:@rjsf/core, modified theObjectFieldwidget to replicate theadditionalPropertiesbehaviour@rjsf/utils:PATTERN_PROPERTIES_KEYhas been addedcanExpandreturnstrueifpatternPropertiesis present in an object schemagetSchemaTypefunction now returnsobjectalso whenpatternPropertiesis presentretrieveSchemafunction has been extended to support thepatternPropertiesvalidationCaveat
The
handleAddClickmethod of theObjectFieldgenerates a new property with given name and value. WhenadditionalPropertiesis not present in the schema, this new property may not match any of thepatternPropertieskeys, resulting in an invalid property.In this case, a new property with
{ type: 'null' }is generated in order to let the user visualize the key form field and modify the content. TheonKeyChangemethod then takes care of generating a correct form as soon as the key matches one or morepatternPropertieskeys.