fix: Fix #3391 and #3393 (#3408)

* fix: Fix 3391 by restoring creation of empty root objects Fixes #3391 by adding the `excludeObjectChildren` third parameter to the main `getDefaultFormState()` * - Fixes #3393 by properly deduplicating when `schema.default` exists in `schema.examples` * - Fix security warning to add newer versions and to unsupport old ones
rjsf-team · Jan 27, 2023 · 2e96fe2 · 2e96fe2
1 parent 87a9bec
commit 2e96fe2
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,8 +17,32 @@ should change the heading of the (upcoming) version to include a major version b
 -->
 # 5.0.0
 
+## @rjsf/antd
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/bootstrap-4
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/chakra-ui
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
 ## @rjsf/core
 - Updated `MultiSchemaField` to pass `undefined` as the value to the widget when the `selectedOption` is -1, supporting `SelectWidget` implementations that allow the user to clear the selected value of the `anyOf`/`oneOf` field.
+- Updated `Form` to support receiving an optional `ref` prop.
+- Updated `Form` to restore providing empty root level objects, fixing [#3391](https://github.com/rjsf-team/react-jsonschema-form/issues/3391)
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/fluent-ui
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/material-ui
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/mui
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
+
+## @rjsf/semantic-ui
+- Fixed `schema.examples` to deduplicate when `schema.default` exists in the examples, fixing [#3393](https://github.com/rjsf-team/react-jsonschema-form/issues/3393)
 
 # 5.0.0-beta.19
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -3,9 +3,12 @@
 ## Supported Versions
 
 | Version | Supported          |
-| ------- | ------------------ |
-| 2.x   | :white_check_mark: |
-| 1.x   | :white_check_mark: |
+|---------|--------------------|
+| 5.x     | :white_check_mark: |
+| 4.x     | :warning:          |
+| 3.x     | :x:                |
+| 2.x     | :x:                |
+| 1.x     | :x:                |
 
 
 ## Reporting a Vulnerability

diff --git a/packages/antd/src/templates/BaseInputTemplate/index.tsx b/packages/antd/src/templates/BaseInputTemplate/index.tsx
@@ -91,10 +91,14 @@ export default function BaseInputTemplate<
   return (
     <>
       {input}
-      {schema.examples && (
+      {Array.isArray(schema.examples) && (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/bootstrap-4/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/bootstrap-4/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -67,10 +67,14 @@ export default function BaseInputTemplate<
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
       {children}
-      {schema.examples ? (
+      {Array.isArray(schema.examples) ? (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example: any) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/chakra-ui/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/chakra-ui/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -80,10 +80,14 @@ export default function BaseInputTemplate<
         list={schema.examples ? examplesId<T>(id) : undefined}
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
-      {schema.examples ? (
+      {Array.isArray(schema.examples) ? (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example: any) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/core/src/components/Form.tsx b/packages/core/src/components/Form.tsx
@@ -321,7 +321,8 @@ export default class Form<
     }
     const formData: T = schemaUtils.getDefaultFormState(
       schema,
-      inputFormData
+      inputFormData,
+      "excludeObjectChildren"
     ) as T;
     const retrievedSchema = schemaUtils.retrieveSchema(schema, formData);
 

diff --git a/packages/core/src/components/templates/BaseInputTemplate.tsx b/packages/core/src/components/templates/BaseInputTemplate.tsx
@@ -92,13 +92,15 @@ export default function BaseInputTemplate<
       />
       {Array.isArray(schema.examples) && (
         <datalist key={`datalist_${id}`} id={examplesId<T>(id)}>
-          {[
-            ...new Set(
-              schema.examples.concat(schema.default ? [schema.default] : [])
-            ),
-          ].map((example: any) => (
-            <option key={example} value={example} />
-          ))}
+          {(schema.examples as string[])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
+            .map((example: any) => {
+              return <option key={example} value={example} />;
+            })}
         </datalist>
       )}
     </>

diff --git a/packages/fluent-ui/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/fluent-ui/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -111,10 +111,14 @@ export default function BaseInputTemplate<
         {...uiProps}
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
-      {schema.examples && (
+      {Array.isArray(schema.examples) && (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example: any) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/material-ui/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/material-ui/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -86,10 +86,14 @@ export default function BaseInputTemplate<
         {...(textFieldProps as TextFieldProps)}
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
-      {schema.examples && (
+      {Array.isArray(schema.examples) && (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example: any) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/mui/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/mui/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -86,10 +86,14 @@ export default function BaseInputTemplate<
         {...(textFieldProps as TextFieldProps)}
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
-      {schema.examples && (
+      {Array.isArray(schema.examples) && (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example: any) => {
               return <option key={example} value={example} />;
             })}

diff --git a/packages/semantic-ui/src/BaseInputTemplate/BaseInputTemplate.tsx b/packages/semantic-ui/src/BaseInputTemplate/BaseInputTemplate.tsx
@@ -78,10 +78,14 @@ export default function BaseInputTemplate<
         onFocus={_onFocus}
         aria-describedby={ariaDescribedByIds<T>(id, !!schema.examples)}
       />
-      {schema.examples && (
+      {Array.isArray(schema.examples) && (
         <datalist id={examplesId<T>(id)}>
           {(schema.examples as string[])
-            .concat(schema.default ? ([schema.default] as string[]) : [])
+            .concat(
+              schema.default && !schema.examples.includes(schema.default)
+                ? ([schema.default] as string[])
+                : []
+            )
             .map((example) => {
               return <option key={example} value={example} />;
             })}