Mixed support #2409

kchobantonov · 2024-12-30T07:41:14Z

provide support for mixed types
fix clearing of inputs when not under an object - e.g. string once cleared will become empty string rather than to return undefined to remove the property from the parent object
fix date controls, now the date can show year, year/month and etc. depending on the control option views
improve the performance to convert dayjs format into maska format function
fixing the :key to at least have the collection size into the key so when the size changes the vue will not reuse html elements leaving attributes like id unchanged
add more examples to show how the mixed control can be used
use arraySchema from the mapped values rather than using Resolve
minor UI changes to use less space
core changes : use the provided schema when the resolve failed, make sure that boolean is valid schema as well - e.g. items: true is valid schema (Note: the last change for the items to be boolean was reverted back since more code should be adjusted - maybe a future improvement)
introduce a new config - allowAdditionalPropertiesIfMissing - this allows to show the additioanalProperties UI when the additionalProperties and patternProperties do not exist. The reason is that by default if the additionalProperties is missing from the schema the default should be considered as true but the UI component does not respect that default - e.g. it needs to be explicitly states as additionalProperties: true if the UI control is needed without the allowAdditionalPropertiesIfMissing config

…ot part of the object that has the property defined in properties then to not clear it - e.g. send undefined value

…tions.views

… based on index - e.g. prevent reusing elements when the array change size which will cause id properties for example to not have correct value

…tified for the new value

…ke so much space

…er the Group

…n also allow such case to be handled by the object renderer

…s no need to resolve that schema just use it

…n the mixed renderer selected object type

… easier

netlify · 2024-12-30T07:41:32Z

✅ Deploy Preview for jsonforms-examples ready!

Name	Link
🔨 Latest commit	`8f862d7`
🔍 Latest deploy log	https://app.netlify.com/sites/jsonforms-examples/deploys/681e9ae1ae7e64000841edff
😎 Deploy Preview	https://deploy-preview-2409--jsonforms-examples.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

… in the core should be adjusted to handled that case

kchobantonov · 2024-12-30T08:11:45Z

@sdirix please review - checkout the new examples

For example 3 the easier way to see that is to copy any example json data, provided it in the example ( Data tab - save it) and see the result in the Demo tab

coveralls · 2025-01-07T10:40:44Z

coverage: 82.453% (-0.06%) from 82.517%
when pulling 6b863d9 on kchobantonov:mixed-support
into 0628b99 on eclipsesource:master.

sdirix · 2025-01-10T10:12:58Z

Thanks for the contribution ❤️ I'll take a look within January 👍

sdirix

Hi @kchobantonov,

I had a first look at the implementation. The examples work great and are really impressive ❤️

I added some comments, please have a look

packages/core/src/mappers/renderer.ts

packages/core/src/util/resolvers.ts

sdirix · 2025-02-12T16:16:53Z

packages/core/src/util/resolvers.ts

+  if (
+    typeof schema === 'boolean' &&
+    (!pathSegments || pathSegments.length === 0)
+  ) {
+    // add the case where the schema can be true value for example: items: true or additionalProperties: false
+    return schema;
+  }


What is the use case of this? Who hands over segments to resolve if the schema is just a boolean already anyway?

that is to resolve the case where the value of the last path segment is equals to true. For example items: true and you want to bind that items then you need to resolve the jsonschema which can be boolean but in the code we ignore that this can be ever the case.

Also the next check for isEmpty if we pass true/false values which are valid JSON schema will return an undefined when resolved instead of boolean

The case is already handled via

if (!pathSegments || pathSegments.length === 0) { return schema; }

If having a boolean schema breaks the checks before that, then we should fix those checks instead of hard coding the exception at the top.

I guess the typing does not properly reflect that the schema could be a boolean. So we should adjust the typing and the checks to handle the typing.

the issue was that if I was going to adjust the typing to allow true/false to be valid schema then there was a lot more changes to the code that just this one - so if the goal is go make the typing correct and the amount of changes to not be an issue then that is fine but I didn't wanted to change a lot of stuff in the core packages that was the reason to have that there

sdirix · 2025-02-12T16:18:08Z

packages/vue-vuetify/src/complex/AllOfRenderer.vue

@@ -20,7 +20,7 @@
        />
        <dispatch-renderer
          v-for="(allOfRenderInfo, allOfIndex) in allOfRenderInfos"
-          :key="`${control.path}-${allOfIndex}`"
+          :key="`${control.path}-${allOfRenderInfos.length}-${allOfIndex}`"


Why adapt this key?

because if the size of the allOfRendererInfo changes then the key is not stable enough to guarantee that previous keys will point the exact same elements - e.g. we do not have a primary key for the info that we can use - usually this happens when we change the UI schema and the schema have to be applied again.

Seems weird as this only fixes the case in which the uischema or schema changes and the length ALSO changes. It will not work if the length does not change.

I wonder whether there should be a change higher up, for example setting a key on the whole form and increasing it whenever we hand over a new schema or uischema. This would be a more generic fix covering all use cases, instead of only a partial fix, covering some of the use cases.

I agree as well but then we do need that on the core level - for now at least that is fixing the issue that I was having when I change the uischema from the monaco editor in our vue examples. So once this is available at the core - maybe some id for the uischema changes then we can utilize that.

packages/vue-vuetify/src/complex/ArrayControlRenderer.vue

packages/vue-vuetify/src/util/composition.ts

packages/vue-vuetify/src/controls/EnumControlRenderer.vue

packages/vue-vuetify/src/extended/AutocompleteEnumControlRenderer.vue

packages/vue-vuetify/src/extended/AutocompleteOneOfEnumControlRenderer.vue

packages/vue-vuetify/src/controls/AnyOfStringOrEnumControlRenderer.vue

kchobantonov · 2025-02-13T23:32:56Z

@sdirix check my responses and also updated repo but it looks like the build failed perhaps because netlify is using greater than pnpm version 8 now ?

sdirix

I have concerns about the proposed changes to the core functionality.

Please have a look at my new comments and the unresolved comments from my previous review.

packages/core/src/mappers/renderer.ts

sdirix · 2025-03-24T11:54:59Z

packages/core/src/util/resolvers.ts

+  if (
+    typeof schema === 'boolean' &&
+    (!pathSegments || pathSegments.length === 0)
+  ) {
+    // add the case where the schema can be true value for example: items: true or additionalProperties: false
+    return schema;
+  }


The case is already handled via

if (!pathSegments || pathSegments.length === 0) { return schema; }

If having a boolean schema breaks the checks before that, then we should fix those checks instead of hard coding the exception at the top.

I guess the typing does not properly reflect that the schema could be a boolean. So we should adjust the typing and the checks to handle the typing.

sdirix · 2025-03-24T11:59:55Z

packages/vue-vuetify/src/complex/AllOfRenderer.vue

@@ -20,7 +20,7 @@
        />
        <dispatch-renderer
          v-for="(allOfRenderInfo, allOfIndex) in allOfRenderInfos"
-          :key="`${control.path}-${allOfIndex}`"
+          :key="`${control.path}-${allOfRenderInfos.length}-${allOfIndex}`"


Seems weird as this only fixes the case in which the uischema or schema changes and the length ALSO changes. It will not work if the length does not change.

I wonder whether there should be a change higher up, for example setting a key on the whole form and increasing it whenever we hand over a new schema or uischema. This would be a more generic fix covering all use cases, instead of only a partial fix, covering some of the use cases.

packages/vue-vuetify/src/complex/MixedRenderer.entry.ts

…d renderer handle the true value directly

kchobantonov · 2025-05-08T10:09:48Z

@sdirix please review again - here are the outstanding items that I need to check with you if you are ok with those as they are at the moment with the explanation that was provided.

change in the packages/core/src/util/resolvers.ts - I have added the reason why is that but I haven't yet resolved the conversation
the changes to the :key to include the size of the layout items is still there at least until there is some support from the core to know when the uischema is changes to use the proper key that will work on all changes to the layout data - e.g. reordering and etc.
the issue where when we want to clear an input that is part of the additionalProperties (e.g. dynamic) and the type is an enum that we use an empty string as a reset value - not sure at the moment how to handle that one with a valid enum value since clearing does not necessary means to select any of the valid values from the supported enum set. Before that this change was not needed but then we were having an issue when we wanted to set the JSON as a data and that to be reflected by the UI - e.g. removing a dynamic field from the JSON and applying that to the form was not having an effect - that is why this change with what to set the value when the control clears the value was needed

… and we have patternProprties

kchobantonov added 30 commits December 29, 2024 03:07

initial mixed renderer support

f8c2caf

organize imports

c078710

handle correctly the clear where if the property that is cleared in n…

ece92ac

…ot part of the object that has the property defined in properties then to not clear it - e.g. send undefined value

update controls to properly send clear value

bd28667

update control to properly send clear value and add support for UI op…

a62efb4

…tions.views

optimize the performance of convertDayjsToMaskaFormat function

4bc6b73

fix key property where the value is not based on data primary key but…

4716a43

… based on index - e.g. prevent reusing elements when the array change size which will cause id properties for example to not have correct value

organize imports

807546f

add translations

25300db

make sure that we use new date so that the proxyModel is correctly no…

81c81db

…tified for the new value

no need to check props?.schema?.properties

3a4f2b9

proper implementation for the optional translator

6b5dca8

change the way how we determine if default value should be returned

2f96aef

use control.arraySchema instead of Resolve

cc44091

use control.arraySchema instead of Resolve, make the header to not ta…

d460e6c

…ke so much space

clean up class

1f24b21

use less space

d716953

do not render the div if nothing to renders as children

498cbf1

use more descriptive name

72e17d0

if we are in dynamic context then always prefer the VerticalLayout ov…

89bfb0b

…er the Group

if the schema is an object that is selected because of mixed type the…

ef24610

…n also allow such case to be handled by the object renderer

when the mixed renderer provides the exact schema to use then there i…

492e5fd

…s no need to resolve that schema just use it

add core schema meta-schema as example

434a1f9

Merge branch 'master' into mixed-support

532fa9f

resolve schema like 'items': true

22760af

add jsonschema example

8a1b523

symplify how we determine that the object renderer should be used whe…

1d51ee8

…n the mixed renderer selected object type

items in draft7 can accept boolean

770531a

add generic json editor example

6ead876

fix items.type

b7460ab

add some space as title so opening and closing the expansion panel is…

27c11fe

… easier

kchobantonov added 3 commits December 30, 2024 02:54

for now revert back the change to include the boolean since more code…

318950e

… in the core should be adjusted to handled that case

fix the check because of the items type revert

3a6f240

use type array instead of true because of the items type revert

e3c8b3c

remove unused imports

40dc34f

Merge branch 'master' into mixed-support

a7fa97b

sdirix reviewed Feb 12, 2025

View reviewed changes

kchobantonov and others added 3 commits February 13, 2025 18:13

remove ?

9111316

remove prop param

0a6047f

Merge branch 'master' into mixed-support

1c146bd

kchobantonov and others added 3 commits February 13, 2025 18:44

remove prop

fd7efb4

Merge branch 'master' into mixed-support

0e1577b

Merge branch 'master' into mixed-support

6b863d9

sdirix reviewed Mar 24, 2025

View reviewed changes

kchobantonov added 3 commits May 5, 2025 17:15

remove changing the schema from true to mixed types and make the mixe…

ad8f056

…d renderer handle the true value directly

update mixed renderer and remove changes in the core to support it

d05642a

Merge branch 'master' into mixed-support

3d632b7

kchobantonov requested a review from sdirix May 8, 2025 10:04

kchobantonov and others added 3 commits May 8, 2025 14:13

expand the property name check when the additionalProperties is false…

82fb3be

… and we have patternProprties

Merge branch 'master' into mixed-support

33e451c

add additionalErrors into the event

8f862d7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mixed support #2409

Mixed support #2409

kchobantonov commented Dec 30, 2024 •

edited

Loading

netlify bot commented Dec 30, 2024 •

edited

Loading

kchobantonov commented Dec 30, 2024

coveralls commented Jan 7, 2025 •

edited

Loading

sdirix commented Jan 10, 2025

sdirix left a comment

sdirix Feb 12, 2025

kchobantonov Feb 13, 2025 •

edited

Loading

sdirix Mar 24, 2025

kchobantonov May 5, 2025

sdirix Feb 12, 2025

kchobantonov Feb 13, 2025

sdirix Mar 24, 2025

kchobantonov May 5, 2025

kchobantonov commented Feb 13, 2025

sdirix left a comment

sdirix Mar 24, 2025

sdirix Mar 24, 2025

kchobantonov commented May 8, 2025 •

edited

Loading

Mixed support #2409

Are you sure you want to change the base?

Mixed support #2409

Conversation

kchobantonov commented Dec 30, 2024 • edited Loading

netlify bot commented Dec 30, 2024 • edited Loading

✅ Deploy Preview for jsonforms-examples ready!

kchobantonov commented Dec 30, 2024

coveralls commented Jan 7, 2025 • edited Loading

sdirix commented Jan 10, 2025

sdirix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kchobantonov Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kchobantonov commented Feb 13, 2025

sdirix left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kchobantonov commented May 8, 2025 • edited Loading

kchobantonov commented Dec 30, 2024 •

edited

Loading

netlify bot commented Dec 30, 2024 •

edited

Loading

coveralls commented Jan 7, 2025 •

edited

Loading

kchobantonov Feb 13, 2025 •

edited

Loading

kchobantonov commented May 8, 2025 •

edited

Loading