Adding ‘null’ and ‘object’ type to property values for a schema

[RhysMAdey]

Describe the bug

Hi,

I am trying to set a ‘type: [‘null’, ‘object’]’ for a schema item with the below code as an example:

schema={{
     type: 'object',
     properties: {
          name: {
               type: 'string',
               description: 'Name example'
          },
          geometry: {
               type: ['null', 'object'],
               properties: {
                    shape: {
                         type: 'string'
                         description: 'Example geometry shape property'
                    },
                    etc........
               }
          }
     }
}}

When I put this schema into my code it kills my app. Adding in type: 'object' it works fine.

Is it allowed to have type: ['null', 'object'] as I have done in the geometry section above?

Expected behavior

both types null and object will be applied to a properties property.

Steps to reproduce the issue

add

{
     type: 'object',
     properties: {
          name: {
               type: 'string',
               description: 'Name example'
          },
          geometry: {
               type: ['null', 'object'],
               properties: {
                    shape: {
                         type: 'string'
                         description: 'Example geometry shape property'
                    },
                    etc........
               }
          }
     }
}

into the schema option of JSON forms

Screenshots

No response

Which Version of JSON Forms are you using?

3.4.1

Package

No response

Additional context

No response

[klcd]

Any directions how this could be fixed? In my json-schemas I often have properties like this

        "config": {
            "anyOf": [
                {
                    "$ref": "#/$defs/config"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
        }

which afaik would better represented by the above.

[destinyFvcker]

Any directions how this could be fixed? In my json-schemas I often have properties like this

        "config": {
            "anyOf": [
                {
                    "$ref": "#/$defs/config"
                },
                {
                    "type": "null"
                }
            ],
            "default": null,
        }

which afaik would better represented by the above.

Hello! And for everyone who has encountered this problem, I discovered this issue was due to the missing Tester and Renderer for rendering {type: "null"}.So you can solve this problem by providing them manually.

Below is my implementation:

• Tester

import { and, schemaTypeIs, uiTypeIs } from "@jsonforms/core";

/**
 * Tests whether the given UI schema is of type Control and if the schema
 * is of type null
 * @type {Tester}
 */
export const isNullControl = and(uiTypeIs("Control"), schemaTypeIs("null"));

• Renderer (I'm using shadcn-vue)

<script setup lang="ts">
import { type ControlElement } from "@jsonforms/core";
import { rendererProps, useJsonFormsControl } from "@jsonforms/vue";
import { CircleSlashIcon } from "@lucide/vue";
import { Empty } from "../../ui/empty";
import { useShadcnControl } from "../utils";

const props = defineProps({
	...rendererProps<ControlElement>(),
});

const { onChange } = useShadcnControl(useJsonFormsControl(props));
// all we need is set it to null
onChange(null);
</script>

<template>
	<Empty class="border border-dashed">
		<EmptyHeader>
			<EmptyMedia variant="icon">
				<CircleSlashIcon />
			</EmptyMedia>
			<EmptyTitle>NULL</EmptyTitle>
			<EmptyDescription> represent null in anyof schema </EmptyDescription>
		</EmptyHeader>
	</Empty>
</template>

• combination tester and renderer

import { rankWith, type JsonFormsRendererRegistryEntry } from "@jsonforms/core";
import controlRenderer from "./NullControlRenderer.vue";
import { isNullControl } from "../testers";
export const entry: JsonFormsRendererRegistryEntry = {
	renderer: controlRenderer,
	tester: rankWith(3, isNullControl),
};

• effect:

for jsonSchema like:

const schema = {
	$schema: "http://json-schema.org/draft-07/schema#",
	title: "MyStruct",
	type: "object",
	properties: {
		myBool: {
			type: "boolean",
		},
		myNullableEnum: {
			anyOf: [
				{
					type: "null",
				},
				{
					$ref: "#/definitions/MyEnum",
				},
			],
			default: null,
		},
		myNumber: {
			type: "integer",
			format: "int32",
		},
	},
	additionalProperties: false,
	required: ["myNumber", "myBool"],
	definitions: {
		MyEnum: {
			anyOf: [
				{
					type: "string",
				},
				{
					type: "object",
					properties: {
						floats: {
							type: "array",
							items: {
								type: "number",
								format: "float",
							},
						},
					},
					required: ["floats"],
				},
			],
		},
	},
};

For those who want to know more details, here is the repo: https://github.com/destinyFvcker/jsonforms-shadcn-vue-renderers